Documentation Powered by ReDoc

Mikrokasa API - wersja rozwojowa (1.1.4)

Pobierz specyfikację OpenAPI:Download

E-mail: it@mikrokasa.pl URL: https://mikrokasa.pl/kontakt

(1.1.4) Zmiany względem wersji 1.1.3

  • Dodanie sposobu podpisania umowy AUTENTI oraz modyfikacja wymagań dla sposobu podpisania umowy INTERNET: jeśli wybrany we wniosku sposób podpisania umowy to INTERNET lub AUTENTI, to wymagane jest podanie komórkowego numeru telefonu w danych kontaktowych wnioskodawcy.
  • Drobne niejasności, błędy i literówki w dokumentacji.

(1.1.3) Zmiany względem wersji 1.1.2

  • Dodanie endpointa na wysyłkę danych z Kontomatika: jeśli dane z konta bankowego klienta zostały pozyskane przez Kontomatik, to można je wysłać przez API agencyjne. Klient nie musi się w takim przypadku logować przez stronę Mikrokasy. Poprawna wysyłka danych z Kontomatika odblokowuje status OFFER_ACCEPTED dla ofert na pełną dokumentację.

(1.1.2) Zmiany względem wersji 1.0.2

  • Dodanie nowych statusów: AUTOMATIC_ANALYSIS (Automatyczna analiza) oraz OFFER_ACCEPTED (Oferta zaakceptowana). Pierwszy jest statusem wewnętrznym, a drugi należy ustawić potwierdzając ofertę.
  • Zmiana procesu akceptacji ofert. Aktualnie aby zaakceptować ofertę, należy przy zmianie statusu podać id wybranej oferty, kwotę i liczbę rat uzgodnioną z klientem. Szczegóły: patrz endpoint /api/v2/application/{applicationId}/status (obiekt offer).
  • Zmiana struktury obiektu oferta.
  • Dodanie nowych parametrów do wniosku: przyznany produkt (pole actualProductId), przyznana liczba rat (obiekt actualScheduleData). Pola są ustawiane po akceptacji oferty lub przyznaniu pożyczki. Dzięki temu oryginalne parametry wnioskowane pozostają bez zmian.
  • Zablokowanie możliwości edycji wnioskowanych parametrów pożyczki (produkt, kwota, liczba rat) poza statusami TEMPORARY i TO_FILL (z NEW).
  • Dodanie callbacka na potwierdzenie zalogowania klienta przez Kontomatik celem umożliwienia akceptacji oferty na pełną dokumentację.

Wprowadzenie

Mikrokasa API to interfejs programistyczny przygotowany dla Partnerów firmy Mikrokasa S.A. Został zrealizowany według wzorca REST. Komunikacja polega na wysłaniu żądania HTTP (GET, POST, PUT, DELETE) pod odpowiedni adres endpointa razem z ewentualnymi wymaganymi danymi w formacie JSON.

Podstawowe funkcje Mikrokasa API

  • Składanie wniosków pożyczkowych
  • Przeglądanie i modyfikacja złożonych wniosków pożyczkowych
  • Procesowanie wniosków według ustalonego workflow.
  • Pobieranie dokumentów

Oznaczenia stosowane w dokumencie

Aby ułatwić znalezienie potrzebnych informacji oznaczyliśmy poszczególne opisy następującymi tagami:

  • Konto użytkownika - informacje dotyczące obsługi konta oraz logowania,
  • Walidacje - metody umożliwiające sprawdzenie poprawności danych,
  • Zgody - informacje w zakresie obsługi zgód
  • Pobieranie danych - metody pozwalające na pobranie danych z systemu,
  • Wnioski - obsługa wniosków od złożenia do umowy,
  • Pliki - obsługa plików (załączniki do wniosków i umów),
  • Komentarze - obsługa komentarzy do wniosków.

Konwencje stosowane w API

  • Requesty i response'y są kodowane w UTF-8.
  • Kody statusów zwracanych w odpowiedziach są zgodne z listą kodów HTTP.
  • Do przekazywania daty i czasu wykorzystywany jest timestamp przekazywany jako number. Należy podawać czas uniksowy w strefie UTC w milisekundach, np. 1764111600000.
  • Walidacja pól jest realizowana dwuetapowo. W opisach poszczególnych pól podano obie walidacje (jeśli występują). Jeśli jest tylko jedna walidacja i nie podano inaczej, to znaczy, że jest to walidacja na zapisanie rekordu.
    • Zapisanie rekordu: rekord musi być poprawny względem wymagalności pól, wartość w polu musi być zgodna z walidacją (np. PESEL, NIP, data).
    • Złożenie wniosku: rekord musi spełniać zależności względem innych rekordów oraz być kompletny względem założeń biznesowych. Walidacja ta jest wykonywana przy zmianie statusu na NEW oraz przy każdej edycji wniosku.
  • Pola oznaczone jako nullable nie są przekazywane w response'ach jeśli są null-em. W niektórych wypadkach takie pole może nie zostać przekazane nawet jeśli zawiera wartość.
  • Edycja rekordu wymaga podania wszystkich danych wprowadzonych wcześniej. Brak danych jest traktowany jak ich usunięcie.

Obsługa błędów

W przypadku błędów walidacji danych w body odpowiedzi przekazywana jest struktura:

{
    "code": 0,
    "description": "string",
    "validationElements": []
}

W polu description znajdują się informacje dla użytkownika (opis błędu). Pozostałe pola są przestarzałe i nie zaleca się korzystania z nich.

Dostęp do serwisu demo

W celu utworzenia konta należy skontaktować się z nami drogą mailową wysyłając prośbę o utworzenie konta na adres kontaktowy. W ramach zgłoszenia należy przekazać:

  • nazwę firmy,
  • imię i nazwisko osoby kontaktowej,
  • email, który zostane użyty do potwierdzenia konta,
  • opcjonalnie: login do konta.

Typy danych

W Mikrokasa API stosowane są typy danych zdefiniowanych dla formatu JSON.

Proste

Podstawowe typy danych opisane są pod tym adresem. Dla większej przejrzystości oczekiwanych danych w niniejszym opisie stosujemy dwa typy dla określania wartości liczbowych:

  • integer - dozwolona jest liczba całkowita, włączając timestamp,
  • number - dozwolona jest dowolna liczba zmiennoprzecinkowa.

Złożone

Złożone typy danych (obiekty) stosowane w Mikrokasa API opisane są w response'ach. Najważniejszy obiekt wykorzystywany podczas obsługi klientów stanowią wnioski o pożyczkę. Wnioski procesowane są według ustalonytch statusów. W zależności od statusu poszczególne pola/obiekty we wniosku mogą być wymagane lub nie, mieć określone wartości itp.
Szczegóły procesu ustalane są na etapie podpisywania umowy z partnerem. W niniejszej dokumentacji opisane są wymaganie, które są niezależne od procesu.

Słowniki

Główne słowniki stosowane w Mikrokasa API opisane są w kolejnych sekcjach. Dozwolone wartości słownikowe opisane są także bezpośrednio w metodach.

Statusy wniosków

Ze względu na liczne warianty realizacji procesu obsługi klientów przejścia między statusami mogą mieć różne ścieżki. Poniżej opisano możliwe statusy oraz przejścia w standardowej sytuacji (podpisanie umowy w agencji). Szczegóły ustalane są na etapie podpisywania umowy między partnerem a Mikrokasą. System ułatwia realizację procesu zwracając w obiekcie wniosek listę statusów możliwych do nadania w danym momencie.

Nazwa Opis
TEMPORARY Tymczasowy. Na tym etapie wniosek nie jest traktowany jako złożony. Przy zapisie wykonywane są tylko podstawowe walidacje poprawności pól. Na tym etapie można wprowadzić wszystkie dane, edytować je oraz zwalidować ich poprawność.
CONSENT_AGREEMENT Akceptacja zgód. Etap dostępny tylko dla wniosków ze sposobem wyrażenia zgody TEXT_MESSAGE. Na tym etapie wysyłany jest sms z kodem weryfikacyjnym. Wniosek można odczytywać, jednak nie można wykonywać zmian. Wniosek musi być kompletny i poprawny. Można wysłać żądanie ponownej wysyłki sms.
NEW Nowy. Na tym etapie wniosek trafia do pracowników Mikrokasy. Można go odczytywać, jednak nie można wykonywać zmian. Wniosek musi być kompletny i poprawny.
AUTOMATIC_ANALYSIS Automatyczna analiza. Wniosek poddawany jest analizie automatycznej. Można go odczytywać, jednak nie można wykonywać zmian.
IN_ANALYSIS W analizie. Wniosek poddawany jest szczegółowej analizie. Można go odczytywać, jednak nie można wykonywać zmian.
TO_FILL Do uzupełnienia przez agenta. Może wystąpić na etapie wniosku lub umowy. Na etapie wniosku dozowlona jest edycja niektórych danych, na etapie umory - tylko załączanie plików.
OFFER Oferta. Na typ etapie do agenta trafia indywidualna oferta dla klienta. W odpowiedzi należy przesłać komentarz ze stanowiskiem klienta (akceptacja, zmiana warunków) oraz zmienić status na poprzedni. Jeśli klient odmawia, należy zmienić status na ABANDONED.
OFFER_ACEPTED Akceptacja oferty. Klient dokonał wyboru oferty, następuje weryfikacja tożsamości i - w zależności od warunków ofert - dochodu. W przypadku pozytywnej weryfikacji następuje przejście do statusu GRANTED
GRANTED Przyznany. Wniosek został rozpatrzony pozytywnie, rozpoczyna się proces podpisania umowy.
ABANDONED Rezygnacja z wniosku.
REJECTED Odrzucony.
ACCEPTED Umowa zaakceptowana przez Mikrokasa.
TO_CORRECT Do poprawy przez Mikrokasa. Status nadawany przez agenta gdy w umowie są błędy.
CONFIRMED Potwierdzona umowa. Status nadawany przez agenta, wymaga załączenia skanu podpisanej umowy.
TO_SEND Umowa do wysyłki kurierem.
SENT Umowa wysłana kurierem.
RECEIVED Umowa wysłana wcześniej kurierem odebrana przez klienta.
RESIGNATION Rezygnacja z umowy.
TO_PAY Umowa do wypłaty.

Sposób podpisania umowy

Nazwa Opis
AGENCY Przez agenta (w biurze lub innymi drogami, przy czym agent jest odpowiedzialny za dostarczenie prawidłowo podpisanej umowy).
INTERNET Przez serwis Autenti z jednoczesnym założeniem konta w EBOK-u Mikrokasy.
AUTENTI Przez serwis Autenti bez zakładania konta w EBOK-u Mikrokasy.
COURIER Przez kuriera (w zależności od ustaleń kurier jest wysyłany przez Mikrokasa lub agenta).

Sposób wyrażenia zgody

Nazwa Opis
CALL_CENTER Zgody odczytywane są przez agenta telefonicznie, klient wyraża zgodę ustnie. Na żądanie Mikrokasay agent zobowiązany jest dostarczyć nagranie z rozmową, podczas której wyrażono zgody dla danego wniosku.
DOCUMENT Zgody drukowane są na formularzu wniosku przez agenta i podpisywane przez klienta. Agent musi załączyć do wniosku skan podpisanego formularza.
INTERNET Zgody wyrażane są przez klienta na stronie internetowej. Konieczne jest dostarczenie numeru IP, z którego zgody zostały wyrażone.
TEXT_MESSAGE Zgody odczytywane są lub udostępniane przez agenta klientowi na ekranie monitora. Klient otrzymuje sms-em kod, który podaje agentowi, a ten przekazuje go do systemu.

Typy załączników

Nazwa Opis
APPLICATION Ogólny typ dla wniosku (np. skan podpisanego wniosku).
APPLICATION_PERSON Ogólny typ dla klienta we wniosku (np. skan dowodu tożsamości).
AGREEMENT Ogólny typ dla załączników w umowie. Uwaga: nie dotyczy skanów umów!
CONTRACT_PROPOSAL Propozycja umowy możliwa do pobrania jako załącznik (w formacie .pdf).
SIGNED_CONTRACT Podpisana umowa (załącznik o tym typie należy wysyłać przy dołączaniu podpisanej umowy).
UNKNOWN Nieznany; fallback. Każdy inny typ poza wymienionymi powyżej traktowany jest jako UNKNOWN.

Procedury przyznawania pożyczek

Szczegóły dotyczące poszczególnych procedur ustalane są w ramach warunków współpracy na linii Mikrokasa-Partner.

Nazwa Opis
CONSOLIDATION Procedura konsolidacyjna.
FULL_DOCUMENTATION Pełna dokumentacja.
STATEMENT Na oświadczenie.

Dane do uzupełnienia

Wartości stosowane w sytuacji, gdy dane klienta w systemie wymagają korekt.

Nazwa Opis
TO_FILL_CONSOLIDATION_DATA Dane konsolidacyjne.
TO_FILL_CLIENT_DATA Dane klienta.
TO_FILL_OTHER_DATA Inne dane.

Wartości stosowane w sytuacji, gdy konieczne jest załączenie określonych plików/skanów.

Nazwa Opis
TO_FILL_IDENTIFICATION Dokument potwierdzający tożsamość.
TO_FILL_ADDRESS Dokument potwierdzający adres zameldowania.
TO_FILL_BANK Dokument potwierdzający numer rachunku bankowego.
TO_FILL_INCOME Dokument potwierdzający dochód.
TO_FILL_CONSOLIDATION Dokumenty konsolidacyjne.
TO_FILL_APPLICATION Formularz wniosku.
TO_FILL_AGREEMENT Umowa.
TO_FILL_SCHEDULE Harmonogram.
TO_FILL_INFO_FORM Formularz informacyjny.
TO_FILL_OTHER Inny dokument.

Podstawowy proces obsługi wniosku

Przykładowy proces obsługi wniosku dla wariantu podpisania umowy w agencji jest następujący:

Krok Endpoint Strona wywołująca
Zapisanie wniosku POST ​/api​/v2​/application Firma zewnętrzna
Dodanie klienta POST ​/api​/v2​/application​/{applicationId}​/client Firma zewnętrzna
Zwalidowanie poprawności danych GET ​/api​/v2​/application​/{applicationId}​/validate Firma zewnętrzna
Pobranie formularza wniosku GET ​/api​/v2​/application​/{applicationId}​/person​/{personId} Firma zewnętrzna
Pobranie formularza informacyjnego GET ​/api​/v2​/application​/{applicationId}​/infoForm Firma zewnętrzna
Załadowanie skanu podpisanego formularza wniosku POST ​/attachment Firma zewnętrzna
Złożenie wniosku PUT ​/api​/v2​/application​/{applicationId}​/status -> NEW Firma zewnętrzna
Analiza wniosku Callback na zmianę statusu na AUTOMATIC_ANALYSIS Mikrokasa
Przygotowanie oferty dla klienta Callback na zmianę statusu na OFFER Mikrokasa
Pobranie oferty dla klienta GET ​/v3​/application​/{applicationId}​/offer Firma zewnętrzna
Potwierdzenie tożsamości przez klienta przez Kontomatik Callback na możliwość akceptacji oferty Mikrokasa
Zmiana statusu zatwierdzająca akceptację PUT ​/api​/v2​/application​/{applicationId}​/status -> OFFER_ACCEPTED, podane dane oferty Firma zewnętrzna
Potwierdzenie prawidłowości wybranej oferty Callback na zmianę statusu na GRANTED Mikrokasa
Przygotowanie umowy Callback na zmianę statusu na ACCEPTED Mikrokasa
Pobranie wniosku i id załącznika CONTRACT_PROPOSAL GET ​/api​/v2​/application​/{applicationId} Firma zewnętrzna
Pobranie załącznika z propozycją umowy GET ​/attachment​/{attachmentId}​/download (CONTRACT_PROPOSAL) Firma zewnętrzna
Zapisanie skanu podpisanej umowy POST ​/attachment (SIGNED_CONTRACT) Firma zewnętrzna
Zatwierdzenie umowy od strony klienta PUT ​/api​/v2​/application​/{applicationId}​/status -> CONFIRMED Firma zewnętrzna
Wypłata środków Callback na zmianę statusu na TO_PAY Mikrokasa

Authentication

XAuthToken

Mikrokasa API do uwierzytelnienia używa mechanizmu JWT. JWT - Json Web Tokens to otwarty standard oparty na dokumencie RFC7519 - https://tools.ietf.org/html/rfc7519. Odpowiednie biblioteki do użycia w projektach znajdują się pod adresem - https://jwt.io/ Wszystkie requesty poza /account/login i /account/resetPassword wymagają podania X-AUTH-TOKEN. Token autoryzacyjny należy przesyłać z każdym żądaniem do serwera poprzez header X-AUTH-TOKEN. Token autoryzacyjny można rozkodować, aby otrzymać informację o aktualnie zalogowanym koncie. Przykład rozkodowanego tokenu:

{
  "sub": "1d79f6b3-8c38-4b52-9d0f-2161e153102a",
  "agency": true,
  "roles": [
    "AGENT"
  ],
  "agency_id": "e9310bc4-5164-41c3-8f17-f2cd16cba731",
  "exp": 1506854397,
  "iat": 1506850797,
  "account": {
    "firstName": "Demo",
    "lastName": "Api",
    "legacyId": null,
    "id": "1d79f6b3-8c38-4b52-9d0f-2161e153102a",
    "login": "demo-api",
    "email": "demo-api@mikrokasa.pl"
  },
  "jti": "b82a717e-633a-4fa4-9c06-512b74fbaf3d"
}

Opis pól w definicji tokena znajduje się w tabeli.

Nazwa pola Typ Opis
sub String Identyfikator konta w systemie API
agency Boolean W przypadku agencji, pole zawsze zwraca true
roles Lista Lista ról jakie posiada zalogowane konto. Może przyjąć wartości:
  • "AGENT" - konto zwykłego agenta,
  • "AGENCY_MANAGER" - konto kierownika agencji.
agency_id String Identyfikator agencji, do której przypisany jest zalogowany użytkownik.
exp Timestamp Timestamp daty ważności tokena. Po tym czasie token wygasa i należy wykonać ponowne zalogowanie do systemu.
iat Timestamp Timestamp daty wydania tokena.
account Obiekt Obiekt opisujący aktualne konto.
firstName String Imię osoby przypisanej do konta.
lastName String Nazwisko osoby przypisanej do konta.
legacyId String Identyfikator wewnętrzny.
id String Identyfikator konta.
login String Login konta.
email String Email przypisany do konta.
jti String Identyfikator tokena
Security scheme type: API Key
Header parameter name: X-AUTH-TOKEN

Konto użytkownika

Zalogowanie do systemu

Umożliwia zalogowanie się do systemu przy użyciu logina i hasła.

Authorizations:
XAuthToken
Request Body schema: application/json

Umożliwia zalogowanie się do systemu przy użyciu logina i hasła.

login
required
string

Login do systemu Mikrokasa.

password
required
string

Hasło do konta.

Responses

204

Poprawne zalogowanie do systemu. Zwraca w headerze X-AUTH-TOKEN token autoryzacyjny, którego należy użyć w pozostałych requestach.

401

Niezgodność danych logowania lub konta nie ma w systemie.

post /account/login

Serwer testowy

https://api-demo.mikrokasa.pl//account/login

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "login": "string",
  • "password": "string"
}

Przedłużenie sesji

Pobranie nowego tokena.

Authorizations:
XAuthToken

Responses

204

Sukces

get /account/exchangeToken

Serwer testowy

https://api-demo.mikrokasa.pl//account/exchangeToken

Zmiana hasła

Authorizations:
XAuthToken
Request Body schema: application/json

Umożliwia zmianę hasła do konta w systemie. Konieczne jest podanie starego

password
required
string

Aktualne hasło do konta.

newPassword
required
string

Nowe hasło do konta.

passwordConfirm
required
string

Nowe hasło do konta - potwierdzenie.

Responses

200

Sukces

post /account/changePassword

Serwer testowy

https://api-demo.mikrokasa.pl//account/changePassword

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "password": "string",
  • "newPassword": "string",
  • "passwordConfirm": "string"
}

Reset hasła

Powoduje wysłanie wiadomości email na adres zdefiniowany w koncie użytkownika. Wiadomość zawiera link do ustawienia nowego hasła. Nowe hasło nalezy wpisać w przeglądarce internetowej. Stosować w przypadku zapomnienia hasła do konta.

Authorizations:
XAuthToken
query Parameters
login
required
string

Login do konta, dla którego ma zostać zresetowane hasło.

Responses

204

Sukces

put /account/resetPassword

Serwer testowy

https://api-demo.mikrokasa.pl//account/resetPassword

Walidacje

Walidacja NIP

Umożliwia walidację polskiego numeru NIP.

Authorizations:
XAuthToken
path Parameters
nip
required
string

Numer NIP, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/nip/{nip}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/nip/{nip}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Walidacja REGON

Umożliwia walidację polskiego numeru REGON.

Authorizations:
XAuthToken
path Parameters
regon
required
string

Numer REGON, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/regon/{regon}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/regon/{regon}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Walidacja PESEL

Umożliwia walidację polskiego numeru PESEL.

Authorizations:
XAuthToken
path Parameters
pesel
required
string

Numer PESEL, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/pesel/{pesel}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/pesel/{pesel}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "gender": "MALE",
  • "birthDate": 0
}

Walidacja numeru dowodu osobistego

Umożliwia walidację polskiego numeru dowodu osobistego.

Authorizations:
XAuthToken
path Parameters
idNumber
required
string

Numer dowodu osobistego, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/idNumber/{idNumber}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/idNumber/{idNumber}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Walidacja płci względem numeru PESEL

Umożliwia walidację płci względem polskiego numeru PESEL.

Authorizations:
XAuthToken
path Parameters
pesel
required
string

Numer PESEL, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/gender/{pesel}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/gender/{pesel}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "gender": "MALE",
  • "birthDate": 0
}

Walidacja daty urodzenia względem numeru PESEL

Umożliwia walidację daty urodzenia względem polskiego numeru PESEL.

Authorizations:
XAuthToken
path Parameters
pesel
required
string

Numer PESEL, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

get /validation/birthdate/{pesel}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/birthdate/{pesel}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true,
  • "gender": "MALE",
  • "birthDate": 0
}

Walidacja zgodności imienia z płcią z pesela

Umożliwia walidację imienia względem polskiego numeru PESEL. Słowniki imion są zgodne ze słownikami stosowanymi w BIK.

Authorizations:
XAuthToken
Request Body schema: application/json

Imię do walidacji i PESEL, względem którego ma być zwalidowane.

name
required
string

Imię do zwalidowania

pesel
required
string

Numer PESEL względem którego ma być zwalidowane imię

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi

post /names/validate

Serwer testowy

https://api-demo.mikrokasa.pl//names/validate

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "name": "string",
  • "pesel": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "valid": true
}

Walidacja numeru rachunku bankowego

Umożliwia walidację polskiego rachunku bankowego.

Authorizations:
XAuthToken
path Parameters
iban
required
string (Numer rachunku bankowego)

Numer rachunku, który ma zostać zwalidowany. Należy użyć formatu PLNN NNNN NNNN NNNN NNNN NNNN NNNN, przy czym PL jest opcjonalne. Białe znaki i minusy między liczbami są ignorowane.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi.

get /validation/iban/{iban}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/iban/{iban}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Walidacja numeru paszportu

Umożliwia walidację polskiego numeru paszportu.

Authorizations:
XAuthToken
path Parameters
passport
required
string

Numer paszportu, który ma zostać zwalidowany.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi.

get /validation/passport/{passport}

Serwer testowy

https://api-demo.mikrokasa.pl//validation/passport/{passport}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "success": true
}

Sprawdzenie wstępnej zdolności kredytowej

Umożliwia sprawdzenie podstawowej zdolności kredytowej (bez odpytania serwisów zewnętrznych typu BIK czy CRIF).

Authorizations:
XAuthToken
path Parameters
pesel
required
string

Numer PESEL, który ma zostać sprawdzony.

Responses

200

Zapytanie wykonane poprawnie, wynik walidacji w body odpowiedzi.

get /v3/scoring/validate/{pesel}

Serwer testowy

https://api-demo.mikrokasa.pl//v3/scoring/validate/{pesel}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "result": "string"
}

Zgody

Pobranie szablonów zgód

Umożliwia pobranie szablonów zgód wymaganych do złożenia wniosku. W przypadku użycia endpointa bez parametrów zostanie zwrócona lista szablonów dla domyslnego sposobu wyrażenia zgody (DOCUMENT).
UWAGA: zalecane jest aby zawsze wywoływać endpoint z parametrami, aby uniknąć sytuacji, w której klient złoży wniosek ze zgodami, których treści nie odpowiadają wybranemu sposobowi wyrażenia.

Authorizations:
XAuthToken
query Parameters
agreement_method
string (Sposób wyrażenia zgody)
Enum:"CALL_CENTER" "DOCUMENT" "INTERNET" "TEXT_MESSAGE"

Sposób wyrażenia zgody (patrz Słowniki->Sposób wyrażenia zgody).

system_id
string

Identyfikator systemu nadawany indywidualnie dla partnera.

Responses

200

Zapytanie wykonane poprawnie, lista szablonów zgód przekazana w body odpowiedzi.

get /consentTemplate

Serwer testowy

https://api-demo.mikrokasa.pl//consentTemplate

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Ponowne wysłanie kodu SMS

Wywołanie endpointa spowoduje ponowne wysłanie SMS-a z kodem autoryzacyjnym dla osoby zidentyfikowanej przez parametr id. Ponowna wysyłka jest możliwa tylko w statusie CONSENT_AGREEMENT.

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

id
required
string

Identyfikator osoby (UUID) lub PESEL

Responses

204

Zapytanie wykonano poprawnie, przy czym nie jest to 100-procentowe potwierdzenie ponownego wysłania sms-a.

post /consent/authorization/{applicationId}/{id}

Serwer testowy

https://api-demo.mikrokasa.pl//consent/authorization/{applicationId}/{id}

Pobieranie danych

Pobranie danych adresowych dla kodu pocztowego

Umożliwia pobranie danych adresowych dla podanego kodu pocztowego. System nie waliduje kodu pocztowego. W przypadku błędnego kodu zostanie zwrócona pusta lista.

Authorizations:
XAuthToken
path Parameters
postalCode
required
string

Kod pocztowy w formacie XX-XXX

Responses

200

Sukces

get /codes/{postalCode}

Serwer testowy

https://api-demo.mikrokasa.pl//codes/{postalCode}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Pobranie listy produktów

Umożliwia pobranie parametrów produktów skonfigurowanych dla agencji przypisanej do konta. W przypadku błędnego zapytania lub braku produktów dla określonych warunków i/lub danej agencji system zwróci pustą listę.

Authorizations:
XAuthToken

Responses

200

Sukces

post /product/filtered

Serwer testowy

https://api-demo.mikrokasa.pl//product/filtered

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Pobranie produktu według id

Umożliwia pobranie parametrów produktu o podanym id.

Authorizations:
XAuthToken
path Parameters
id
required
string

Identyfikator produktu (UUID)

Responses

200

Sukces

get /product/{id}

Serwer testowy

https://api-demo.mikrokasa.pl//product/{id}

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Wyliczenie kosztów pożyczki

Umożliwia pobranie kosztów pożyczki dla założonych parametrów. Do wykorzystania w kalkulatorach kosztów.

Authorizations:
XAuthToken
query Parameters
product_id
required
string

Identyfikator produktu (UUID)

amount
required
number

Wnioskowana kwota pożyczki

installment_count
required
number

Wnioskowana ilość rat

Responses

200

Sukces

get /v3/estimate

Serwer testowy

https://api-demo.mikrokasa.pl//v3/estimate

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "totalPreparatoryFee": 0,
  • "totalAdministrationFee": 0,
  • "totalInterest": 0,
  • "capital": 0,
  • "amountToPay": 0,
  • "totalLoanCost": 0,
  • "nonInterestLoanCost": 0,
  • "installmentCount": 0,
  • "firstInstallmentDate": 0,
  • "installmentAmount": 0,
  • "rrso": 0
}

Pobranie danych do konsolidacji wewnętrznej

Authorizations:
XAuthToken
path Parameters
pesel
required
string

Numer PESEL wnioskodawcy

paymentType
required
string (Rodzaj płatności)
Enum:"GIRO" "TRANSFER"
Example: "TRANSFER"
  • GIRO - przekaz pocztowy
  • TRANSFER - przelew bankowy

Responses

200
get /bridge/client/{pesel}/loansForConsolidation/{paymentType}

Serwer testowy

https://api-demo.mikrokasa.pl//bridge/client/{pesel}/loansForConsolidation/{paymentType}

Wnioski

Pobranie listy wniosków

Authorizations:
XAuthToken
query Parameters
query
string

Parametry zapytania w formacie: keyword:AND:from:records:sortBy:sortType, gdzie:

  • keyword - słowo kluczowe, które ma być wyszukane; można wyszukiwać według numeru wniosku, danych kliena (imię, nazwisko, pesel) i nazwie produktu. Można podać kilka słów kluczowych rozdzielanych przecinkiem.
  • from - numer rekordu od którego pobierać dane; numeracja zaczyna się od 0.
  • records - liczba rekordów do pobrania.
  • sortBy - nazwa pola, po której dane są sortowane; można użyć pól z wniosku, np. creationDate
  • sortType - sposób sortowania: asc - rosnąco, desc - malejąco.

Responses

200

Lista wniosków spełniających kryteria zapytania.

get /es/applications

Serwer testowy

https://api-demo.mikrokasa.pl//es/applications

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "count": 0,
  • "data":
    [
    ]
}

Złożenie wniosku (bez klienta)

Authorizations:
XAuthToken
Request Body schema: application/json
scheduleData
required
object (Wnioskowane parametry harmonogramu)
paymentType
required
string (Rodzaj płatności)
Enum:"GIRO" "TRANSFER"
  • GIRO - przekaz pocztowy
  • TRANSFER - przelew bankowy
applicationAmount
required
number (Kwota wnioskowana)

Musi mieścić się w przedziale <min;max> wyznaczonym przez wybrany produkt.

productId
required
string (Identyfikator (UUID) produktu.)
agreementSigningWay
required
string (Sposób podpisania umowy)
Enum:"AGENCY" "CALL_CENTER" "COURIER" "INTERNET" "AUTENTI"
  • AGENCY - umowa jest podpisywana przez klienta w agencji w obecności agenta. W zależności od ustaleń agent może reprezentować Mikrokasę lub konieczne będzie przesłanie oryginału umowy do Mikrokasy celem podpisania. W obu przypadkach wypłata środków następuje po przekazaniu skanu podpisanej umowy.
  • CALL_CENTER - umowa podpisywana jest telefonicznie przez konsultanta Mikrokasy. Sposób możliwy do wybrania tylko jeśli sposób wyrażenia zgody to CALL_CENTER.
  • COURIER - umowa podpisywana jest przez klienta w obecności kuriera, który dostarcza dokumenty. W zależności od ustaleń biznesowych wysyłkę zleca agencja lub Mikrokasa. Wypłata realizowana jest po uzyskaniu potwierdzenia odbioru przesyłki.
  • INTERNET - umowa podpisywana jest przez klienta za pośrednictwem portalu Autenti, a w przypadku przyznania wniosku klientowi zakładane jest automatycznie konto w EBOK-u Mikrokasy.
  • AUTENTI - umowa podpisywana jest przez klienta za pośrednictwem portalu Autenti.
consentAgreementMethod
required
string (Sposób wyrażenia zgody)
Enum:"CALL_CENTER" "DOCUMENT" "INTERNET" "TEXT_MESSAGE"
  • CALL_CENTER - Zgody odczytywane są przez agenta telefonicznie, klient wyraża zgodę ustnie. Na żądanie Mikrokasay agent zobowiązany jest dostarczyć nagranie z rozmową, podczas której wyrażono zgody dla danego wniosku.
  • DOCUMENT - Zgody drukowane są na formularzu wniosku przez agenta i podpisywane przez klienta. Agent musi załączyć do wniosku skan podpisanego formularza.
  • INTERNET - Zgody wyrażane są przez klienta na stronie internetowej. Konieczne jest dostarczenie numeru IP, z którego zgody zostały wyrażone.
  • TEXT_MESSAGE - Zgody odczytywane są lub udostępniane przez agenta klientowi na ekranie monitora. Klient otrzymuje sms-em kod, który podaje agentowi, a ten przekazuje go do systemu.
consolidationAgreements
Array of objects (Lista umów konsolidacyjnych)

Responses

200
post /api/v2/application

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "scheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "applicationAmount": 0,
  • "productId": "string",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "consolidationAgreements":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "productId": "string",
  • "actualProductId": "string",
  • "systemId": "string",
  • "applicantsCount": 0,
  • "applicationAmount": 0,
  • "actualAmount": 0,
  • "scheduleData":
    {
    },
  • "actualScheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "number": "string",
  • "status":
    {
    },
  • "availableStatuses":
    [
    ],
  • "clients":
    [
    ],
  • "guarantors":
    [
    ],
  • "attachments":
    [
    ],
  • "applicantType": "PRIVATE_PERSON",
  • "clientType": "PRIVATE_PERSON",
  • "createdBy": "string",
  • "createdAt": 0,
  • "creationTime": 0,
  • "applicationSource": "INTERNAL",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "availableAgreementSigningWays": "AGENCY",
  • "missingDocuments":
    [
    ],
  • "consolidationAgreements":
    [
    ],
  • "offers":
    [
    ],
  • "consentTemplates":
    [
    ],
  • "product":
    {
    },
  • "updatedBy": "string",
  • "addedBy":
    {
    },
  • "updateTime": 0,
  • "consolidation": true,
  • "previousState": "TEMPORARY",
  • "partner":
    {
    },
  • "owner":
    {
    },
  • "callCenter": true
}

Pobranie wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200
get /api/v2/application/{applicationId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "productId": "string",
  • "actualProductId": "string",
  • "systemId": "string",
  • "applicantsCount": 0,
  • "applicationAmount": 0,
  • "actualAmount": 0,
  • "scheduleData":
    {
    },
  • "actualScheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "number": "string",
  • "status":
    {
    },
  • "availableStatuses":
    [
    ],
  • "clients":
    [
    ],
  • "guarantors":
    [
    ],
  • "attachments":
    [
    ],
  • "applicantType": "PRIVATE_PERSON",
  • "clientType": "PRIVATE_PERSON",
  • "createdBy": "string",
  • "createdAt": 0,
  • "creationTime": 0,
  • "applicationSource": "INTERNAL",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "availableAgreementSigningWays": "AGENCY",
  • "missingDocuments":
    [
    ],
  • "consolidationAgreements":
    [
    ],
  • "offers":
    [
    ],
  • "consentTemplates":
    [
    ],
  • "product":
    {
    },
  • "updatedBy": "string",
  • "addedBy":
    {
    },
  • "updateTime": 0,
  • "consolidation": true,
  • "previousState": "TEMPORARY",
  • "partner":
    {
    },
  • "owner":
    {
    },
  • "callCenter": true
}

Edycja wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Request Body schema: application/json
scheduleData
required
object (Wnioskowane parametry harmonogramu)
paymentType
required
string (Rodzaj płatności)
Enum:"GIRO" "TRANSFER"
  • GIRO - przekaz pocztowy
  • TRANSFER - przelew bankowy
applicationAmount
required
number (Kwota wnioskowana)

Musi mieścić się w przedziale <min;max> wyznaczonym przez wybrany produkt.

productId
required
string (Identyfikator (UUID) produktu.)
agreementSigningWay
required
string (Sposób podpisania umowy)
Enum:"AGENCY" "CALL_CENTER" "COURIER" "INTERNET" "AUTENTI"
  • AGENCY - umowa jest podpisywana przez klienta w agencji w obecności agenta. W zależności od ustaleń agent może reprezentować Mikrokasę lub konieczne będzie przesłanie oryginału umowy do Mikrokasy celem podpisania. W obu przypadkach wypłata środków następuje po przekazaniu skanu podpisanej umowy.
  • CALL_CENTER - umowa podpisywana jest telefonicznie przez konsultanta Mikrokasy. Sposób możliwy do wybrania tylko jeśli sposób wyrażenia zgody to CALL_CENTER.
  • COURIER - umowa podpisywana jest przez klienta w obecności kuriera, który dostarcza dokumenty. W zależności od ustaleń biznesowych wysyłkę zleca agencja lub Mikrokasa. Wypłata realizowana jest po uzyskaniu potwierdzenia odbioru przesyłki.
  • INTERNET - umowa podpisywana jest przez klienta za pośrednictwem portalu Autenti, a w przypadku przyznania wniosku klientowi zakładane jest automatycznie konto w EBOK-u Mikrokasy.
  • AUTENTI - umowa podpisywana jest przez klienta za pośrednictwem portalu Autenti.
consentAgreementMethod
required
string (Sposób wyrażenia zgody)
Enum:"CALL_CENTER" "DOCUMENT" "INTERNET" "TEXT_MESSAGE"
  • CALL_CENTER - Zgody odczytywane są przez agenta telefonicznie, klient wyraża zgodę ustnie. Na żądanie Mikrokasay agent zobowiązany jest dostarczyć nagranie z rozmową, podczas której wyrażono zgody dla danego wniosku.
  • DOCUMENT - Zgody drukowane są na formularzu wniosku przez agenta i podpisywane przez klienta. Agent musi załączyć do wniosku skan podpisanego formularza.
  • INTERNET - Zgody wyrażane są przez klienta na stronie internetowej. Konieczne jest dostarczenie numeru IP, z którego zgody zostały wyrażone.
  • TEXT_MESSAGE - Zgody odczytywane są lub udostępniane przez agenta klientowi na ekranie monitora. Klient otrzymuje sms-em kod, który podaje agentowi, a ten przekazuje go do systemu.
consolidationAgreements
Array of objects (Lista umów konsolidacyjnych)

Responses

200
put /api/v2/application/{applicationId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "scheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "applicationAmount": 0,
  • "productId": "string",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "consolidationAgreements":
    [
    ]
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "productId": "string",
  • "actualProductId": "string",
  • "systemId": "string",
  • "applicantsCount": 0,
  • "applicationAmount": 0,
  • "actualAmount": 0,
  • "scheduleData":
    {
    },
  • "actualScheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "number": "string",
  • "status":
    {
    },
  • "availableStatuses":
    [
    ],
  • "clients":
    [
    ],
  • "guarantors":
    [
    ],
  • "attachments":
    [
    ],
  • "applicantType": "PRIVATE_PERSON",
  • "clientType": "PRIVATE_PERSON",
  • "createdBy": "string",
  • "createdAt": 0,
  • "creationTime": 0,
  • "applicationSource": "INTERNAL",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "availableAgreementSigningWays": "AGENCY",
  • "missingDocuments":
    [
    ],
  • "consolidationAgreements":
    [
    ],
  • "offers":
    [
    ],
  • "consentTemplates":
    [
    ],
  • "product":
    {
    },
  • "updatedBy": "string",
  • "addedBy":
    {
    },
  • "updateTime": 0,
  • "consolidation": true,
  • "previousState": "TEMPORARY",
  • "partner":
    {
    },
  • "owner":
    {
    },
  • "callCenter": true
}

Pełna walidacja wniosku

Walidowane są wszystkie pola wymagane do złożenia wniosku poza wymagalnością załączników.

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

204

Wniosek jest prawidłowy i kompletny.

400

Błędy walidacji

get /api/v2/application/{applicationId}/validate

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/validate

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "code": 0,
  • "description": "string",
  • "validationElements": "string"
}

Dodanie klienta do wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Request Body schema: application/json
clientId
string (Identyfikator klienta)

Identyfikator klienta (UUID). Podawany jedynie przy edycji.

bankAccountNumber
string (Numer rachunku do wypłaty pożyczki)

Numer rachunku do wypłaty pożyczki. Wymagany dla głównego wnioskodawcy.

person
required
object (Dane szczegółowe osoby)

Złożenie wniosku: wymagane podanie kompletnego rekordu.

Responses

200
post /api/v2/application/{applicationId}/client

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/client

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "clientId": "string",
  • "bankAccountNumber": "string",
  • "person":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "clientId": "string",
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0,
  • "type": "PRIVATE_PERSON",
  • "mainApplicant": true,
  • "person":
    {
    }
}

Pobranie listy klientów z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200
get /api/v2/application/{applicationId}/client

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/client

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Pobranie klienta z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

clientId
required
string

Identyfikator klienta (UUID)

Responses

200

Dane klienta

get /api/v2/application/{applicationId}/client/{clientId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/client/{clientId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "clientId": "string",
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0,
  • "type": "PRIVATE_PERSON",
  • "mainApplicant": true,
  • "person":
    {
    }
}

Edycja danych klienta we wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

clientId
required
string

Identyfikator klienta (UUID)

Responses

200

Zmienione dane klienta

put /api/v2/application/{applicationId}/client/{clientId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/client/{clientId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "clientId": "string",
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0,
  • "type": "PRIVATE_PERSON",
  • "mainApplicant": true,
  • "person":
    {
    }
}

Usunięcie klienta z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

clientId
required
string

Identyfikator klienta (UUID)

Responses

204

Klient usunięty.

delete /api/v2/application/{applicationId}/client/{clientId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/client/{clientId}

Dodanie poręczyciela do wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Request Body schema: application/json
id
string (Identyfikator rekordu)

Identyfikator rekordu (UUID)

personData
object (Dane personalne) Nullable
pesel
string (Numer PESEL) Nullable

Zwracane jeśli nie istnieje pole personData.

firstName
string (Imię) Nullable

Zwracane jeśli nie istnieje pole personData.

secondName
string Nullable

Drugie imię. Zwracane jeśli nie istnieje pole personData.

lastName
string (Nazwisko) Nullable

Zwracane jeśli nie istnieje pole personData.

gender
string (Płeć)
Enum:"MALE" "FEMALE"
  • MALE - mężczyzna
  • FEMALE - kobieta
birthDate
integer

Data urodzenia

contactData
object (Dane kontaktowe (odpowiedź))
mainIdentification
object (Dokument tożsamości)
registeredAddress
object (Adres zameldowania)
actualAddress
object (Adres korespondencyjny) Nullable
financialSituation
object (Sytuacja finansowa) Nullable
consents
Array of objects (Zgody wyrażone/niewyrażone/odwołane przez osobę) Nullable
attachments
Array of objects (Załączniki dotyczące osoby) Nullable
createdBy
string (Identyfikator twórcy)

Identyfikator użytkownika, który utworzył rekord (UUID)

creationTime
integer (Termin utworzenia)

Termin utworzenia rekordu

updatedBy
string (Identyfikator redaktora) Nullable

Identyfikator użytkownika, który zaktualizował rekord (UUID)

updateTime
integer (Termin utworzenia) Nullable

Termin ostatniej aktualizacji rekordu

Responses

200
post /api/v2/application/{applicationId}/guarantor

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/guarantor

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "personData":
    {
    },
  • "pesel": "string",
  • "firstName": "string",
  • "secondName": "string",
  • "lastName": "string",
  • "gender": "MALE",
  • "birthDate": 0,
  • "contactData":
    {
    },
  • "mainIdentification":
    {
    },
  • "registeredAddress":
    {
    },
  • "actualAddress":
    {
    },
  • "financialSituation":
    {
    },
  • "consents":
    [
    ],
  • "attachments":
    [
    ],
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "personData":
    {
    },
  • "pesel": "string",
  • "firstName": "string",
  • "secondName": "string",
  • "lastName": "string",
  • "gender": "MALE",
  • "birthDate": 0,
  • "contactData":
    {
    },
  • "mainIdentification":
    {
    },
  • "registeredAddress":
    {
    },
  • "actualAddress":
    {
    },
  • "financialSituation":
    {
    },
  • "consents":
    [
    ],
  • "attachments":
    [
    ],
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0
}

Pobranie listy poręczycieli z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200
get /api/v2/application/{applicationId}/guarantor

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/guarantor

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Pobranie poręczyciela z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

guarantorId
required
string

Identyfikator poręczyciela (UUID)

Responses

200
get /api/v2/application/{applicationId}/guarantor/{guarantorId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/guarantor/{guarantorId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "personData":
    {
    },
  • "pesel": "string",
  • "firstName": "string",
  • "secondName": "string",
  • "lastName": "string",
  • "gender": "MALE",
  • "birthDate": 0,
  • "contactData":
    {
    },
  • "mainIdentification":
    {
    },
  • "registeredAddress":
    {
    },
  • "actualAddress":
    {
    },
  • "financialSituation":
    {
    },
  • "consents":
    [
    ],
  • "attachments":
    [
    ],
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0
}

Usunięcie poręczyciela z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

guarantorId
required
string

Identyfikator poręczyciela (UUID)

Responses

204

Poręczyciel usunięty.

delete /api/v2/application/{applicationId}/guarantor/{guarantorId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/guarantor/{guarantorId}

Edycja danych poręczyciela we wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

guarantorId
required
string

Identyfikator poręczyciela (UUID)

Responses

200
put /api/v2/application/{applicationId}/guarantor/{guarantorId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/guarantor/{guarantorId}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "personData":
    {
    },
  • "pesel": "string",
  • "firstName": "string",
  • "secondName": "string",
  • "lastName": "string",
  • "gender": "MALE",
  • "birthDate": 0,
  • "contactData":
    {
    },
  • "mainIdentification":
    {
    },
  • "registeredAddress":
    {
    },
  • "actualAddress":
    {
    },
  • "financialSituation":
    {
    },
  • "consents":
    [
    ],
  • "attachments":
    [
    ],
  • "createdBy": "string",
  • "creationTime": 0,
  • "updatedBy": "string",
  • "updateTime": 0
}

Zmiana statusu wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Request Body schema: application/json
status
required
string (Status wniosku)
Enum:"TEMPORARY" "NEW" "AUTOMATIC_ANALYSIS" "IN_ANALYSIS" "TO_FILL" "OFFER" "OFFER_ACCEPTED" "GRANTED" "ABANDONED" "REJECTED" "ACCEPTED" "TO_CORRECT" "CONFIRMED" "TO_SEND" "SENT" "RECEIVED" "RESIGNATION" "TO_PAY"

Słownik: statusy wniosku

  • TEMPORARY – Tymczasowy.
  • NEW – Nowy.
  • AUTOMATIC_ANALYSIS – W analizie automatycznej.
  • IN_ANALYSIS – W analizie.
  • TO_FILL – Do uzupełnienia przez agenta. Może wystąpić na etapie wniosku lub umowy.
  • OFFER – Oferta.
  • OFFER_ACCEPTED – Akceptacja oferty.
  • GRANTED – Przyznany.
  • ABANDONED – Rezygnacja z wniosku.
  • REJECTED – Odrzucony.
  • ACCEPTED – Umowa zaakceptowana przez Mikrokasa.
  • TO_CORRECT – Do poprawy przez Mikrokasa.
  • CONFIRMED – Potwierdzona umowa.
  • TO_SEND – Umowa do wysyłki kurierem.
  • SENT – Umowa wysłana kurierem.
  • RECEIVED – Umowa wysłana wcześniej kurierem odebrana przez klienta.
  • RESIGNATION – Rezygnacja z umowy.
  • TO_PAY – Umowa do wypłaty.
authorizationCode
string (Kod autoryzacyjny)

Wymagany przy zmianie statusu z CONSENT_AGREEMENT na NEW.

offer
object

Wymagane przy zmianie statusu z OFFER na OFFER_ACCEPTED. W zależności od procedury wybranej oferty należy dodatkowo:

  • STATEMENT - nie są potrzebne dodatkowe akcje
  • FULL_DOCUMENTATION - klient musi zalogować się na swoje konto bankowe przez Kontomatik (link jest wysyłany do niego przy ustawieniu statusu OFFER oraz dodatkowo zapisywany w komentarzu widocznym dla agencji) lub należy załączyć załącznik z potwierdzeniem dochodu lub należy wysłać dane pozyskane z konta klienta przez Kontomatik.
  • CONSOLIDATION - należy załączyć załącznik z dokumentami konsolidacyjnemu. Dodatkowo można załączyć dokument z potwierdzeniem dochodu lub klient może zalogować się na swoje konto bankowe przez Kontomatik.

Responses

200

Zaktualizowany wniosek.

put /api/v2/application/{applicationId}/status

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/status

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "status": "TEMPORARY",
  • "authorizationCode": "string",
  • "offer":
    {
    }
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "productId": "string",
  • "actualProductId": "string",
  • "systemId": "string",
  • "applicantsCount": 0,
  • "applicationAmount": 0,
  • "actualAmount": 0,
  • "scheduleData":
    {
    },
  • "actualScheduleData":
    {
    },
  • "paymentType": "TRANSFER",
  • "number": "string",
  • "status":
    {
    },
  • "availableStatuses":
    [
    ],
  • "clients":
    [
    ],
  • "guarantors":
    [
    ],
  • "attachments":
    [
    ],
  • "applicantType": "PRIVATE_PERSON",
  • "clientType": "PRIVATE_PERSON",
  • "createdBy": "string",
  • "createdAt": 0,
  • "creationTime": 0,
  • "applicationSource": "INTERNAL",
  • "agreementSigningWay": "AGENCY",
  • "consentAgreementMethod": "CALL_CENTER",
  • "availableAgreementSigningWays": "AGENCY",
  • "missingDocuments":
    [
    ],
  • "consolidationAgreements":
    [
    ],
  • "offers":
    [
    ],
  • "consentTemplates":
    [
    ],
  • "product":
    {
    },
  • "updatedBy": "string",
  • "addedBy":
    {
    },
  • "updateTime": 0,
  • "consolidation": true,
  • "previousState": "TEMPORARY",
  • "partner":
    {
    },
  • "owner":
    {
    },
  • "callCenter": true
}

Pobranie statusu wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200
get /api/v2/application/{applicationId}/status

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/status

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "status": "TEMPORARY",
  • "startDate": 0,
  • "applicationId": "string"
}

Pobranie oferty do wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200

Zapytanie wykonane poprawnie, szczegóły w odpowiedzi

get /v3/application/{applicationId}/offer

Serwer testowy

https://api-demo.mikrokasa.pl//v3/application/{applicationId}/offer

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Wysłanie danych Kontomatik

Wysłanie danych Kontomatik wnioskodawcy - dane XML zgodne ze schematem https://developer.kontomatik.com/schema/v1/default_import.xsd

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

id
required
string

Identyfikator osoby (UUID) lub PESEL

Request Body schema: application/xml

Responses

201

Operacja wykonana poprawnie, dane zostały zapisane

post /v3/application/kontomatik/{applicationId}/{personId}

Serwer testowy

https://api-demo.mikrokasa.pl//v3/application/kontomatik/{applicationId}/{personId}

Pliki

Przesłanie pliku do systemu

Zalecane jest, aby przy jednej osobie we wniosku do wszystkich załączników na etapie wniosku używać typu APPLICATION. Przy wiekszej liczbie osób należy użyć typu APPLICATION_PERSON przekazując załączniki dedykowane danej osobie (np. skan dowodu, zaświadczenie o dochodach), a typu APPLICATION używać do załączników dotyczących wniosku ogólnie.
Należy pamiętać, że skan podpisanej umowy musi być załadowana jako plik typu SIGNED_CONTRACT.

Authorizations:
XAuthToken
Request Body schema: multipart/form-data
data
object (Szczegóły załącznika)
bodyFileKey
string <binary>

Responses

200

Szczegóły zapisanego pliku

post /attachment

Serwer testowy

https://api-demo.mikrokasa.pl//attachment

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "creationTime": 0,
  • "description": "string",
  • "filesStorageId": "string",
  • "personId": "string",
  • "attachmentType": "APPLICATION",
  • "creator": "string"
}

Pobranie załącznika

Authorizations:
XAuthToken
path Parameters
attachmentId
required
string

Identyfikator załącznika (UUID)

Responses

200

Plik.

get /attachment/{attachmentId}/download

Serwer testowy

https://api-demo.mikrokasa.pl//attachment/{attachmentId}/download

Usunięcie załącznika

Authorizations:
XAuthToken
path Parameters
attachmentId
required
string

Identyfikator załącznika (UUID)

Responses

204

Plik usunięty.

delete /attachment/{attachmentId}/delete

Serwer testowy

https://api-demo.mikrokasa.pl//attachment/{attachmentId}/delete

Pobranie formularza wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

personId
required
string

Identyfikator osoby (UUID)

Responses

200

Formularz wniosku wypełniony danymi wskazanej osoby.

get /api/v2/application/{applicationId}/person/{personId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/person/{personId}

Pobranie formularza informacyjnego do wniosku

Pobranie formularza informacyjnego do wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200

Formularz informacyjny danego wniosku.

get /api/v2/application/{applicationId}/infoForm

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/infoForm

Pobranie paczki powitalnej do umowy

Wykorzystywana przy podpisaniu umowy za pośrednictwem kuriera wysyłanego do klienta przez agencję.

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

clientId
required
string

Identyfikator klienta (UUID)

Responses

200

Zestaw dokumentów powitalnych dla danej umowy.

get /api/v2/application/{applicationId}/packageCombined/{clientId}

Serwer testowy

https://api-demo.mikrokasa.pl//api/v2/application/{applicationId}/packageCombined/{clientId}

Komentarze

Dodanie komentarza do wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Request Body schema: application/json
content
required
string (Treść komentarza)

Responses

200

Szczegóły dodanego komentarza

post /application/{applicationId}/comment

Serwer testowy

https://api-demo.mikrokasa.pl//application/{applicationId}/comment

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "content": "string"
}

Response samples

application/json
Copy
 Expand all Collapse all
{
  • "content": "string",
  • "id": "string",
  • "createdBy":
    {
    },
  • "creationDate": 0,
  • "forAgency": true,
  • "forVindication": true
}

Pobranie komentarzy z wniosku

Authorizations:
XAuthToken
path Parameters
applicationId
required
string

Identyfikator wniosku (UUID)

Responses

200

Lista komentarzy

get /application/{applicationId}/comment

Serwer testowy

https://api-demo.mikrokasa.pl//application/{applicationId}/comment

Response samples

application/json
Copy
 Expand all Collapse all
[
  • {
    }
]

Callbacks

Poinformowanie o zmianie statusu

Należy przesłać do Mikrokasy następujące informacje:

  • secret - klucz autoryzacyjny - klucz za pomocą którego aplikacja będzie wykonywała autoryzację - przykładowy klucz: SecREtZxs002#
  • external_endpoint - pełen endpoint na który będzie wysyłana informacja o statusie (np. https://integracje.firma.com/status).

Autoryzacja: W headerze w kluczu X-AUTH-TOKEN przesyłany będzie hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem. np:

  • id agencji: 0fe8c0e7-f458-4e52-ae03-d6dc15bed7c4 - identyfikator agencji, dla której należy wniosek; identyfikator ten jest przekazywany we wniosku jako partner.id.
  • secret: SecREtZxs002#
  • wynik: c524daacb87391b137244e5126a30bb0 Powiadomienie o nowym komentarzu będzie periodycznie powtarzane przez tydzień lub do czasu uzyskania odpowiedzi. Powiadomienie o kolejnym statusie jest wysyłane dopiero po otrzymaniu potwierdzenia odebrania callbacka na poprzedni status.
Authorizations:
XAuthToken
header Parameters
X-AUTH-TOKEN
required
string

Hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem.

Request Body schema: application/json
id
string (Identyfikator (UUID) wniosku)
status
string (Status wniosku)
Enum:"TEMPORARY" "NEW" "AUTOMATIC_ANALYSIS" "IN_ANALYSIS" "TO_FILL" "OFFER" "OFFER_ACCEPTED" "GRANTED" "ABANDONED" "REJECTED" "ACCEPTED" "TO_CORRECT" "CONFIRMED" "TO_SEND" "SENT" "RECEIVED" "RESIGNATION" "TO_PAY"

Słownik: statusy wniosku

  • TEMPORARY – Tymczasowy.
  • NEW – Nowy.
  • AUTOMATIC_ANALYSIS – W analizie automatycznej.
  • IN_ANALYSIS – W analizie.
  • TO_FILL – Do uzupełnienia przez agenta. Może wystąpić na etapie wniosku lub umowy.
  • OFFER – Oferta.
  • OFFER_ACCEPTED – Akceptacja oferty.
  • GRANTED – Przyznany.
  • ABANDONED – Rezygnacja z wniosku.
  • REJECTED – Odrzucony.
  • ACCEPTED – Umowa zaakceptowana przez Mikrokasa.
  • TO_CORRECT – Do poprawy przez Mikrokasa.
  • CONFIRMED – Potwierdzona umowa.
  • TO_SEND – Umowa do wysyłki kurierem.
  • SENT – Umowa wysłana kurierem.
  • RECEIVED – Umowa wysłana wcześniej kurierem odebrana przez klienta.
  • RESIGNATION – Rezygnacja z umowy.
  • TO_PAY – Umowa do wypłaty.
date
integer (Termin ustawienia statusu)

Responses

204

Potwierdzenie otrzymania callbacka.

post /external-endpoint-onStatusChange

Serwer testowy

https://api-demo.mikrokasa.pl//external-endpoint-onStatusChange

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "status": "TEMPORARY",
  • "date": 0
}

Poinformowanie o dodaniu komentarza

Należy przesłać do Mikrokasy następujące informacje:

  • secret - klucz autoryzacyjny - klucz za pomocą którego aplikacja będzie wykonywała autoryzację - przykładowy klucz: SecREtZxs002#
  • external_endpoint - pełen endpoint na który będzie wysyłana informacja o statusie (np. https://integracje.firma.com/status).

Autoryzacja: W headerze w kluczu X-AUTH-TOKEN przesyłany będzie hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem. np:

  • id agencji: 0fe8c0e7-f458-4e52-ae03-d6dc15bed7c4 - identyfikator agencji, dla której należy wniosek; identyfikator ten jest przekazywany we wniosku jako partner.id.
  • secret: SecREtZxs002#
  • wynik: c524daacb87391b137244e5126a30bb0 Powiadomienie o nowym komentarzu będzie periodycznie powtarzane przez tydzień lub do czasu uzyskania odpowiedzi. Powiadomienie o kolejnym komentarzu jest wysyłane dopiero po otrzymaniu potwierdzenia odebrania callbacka na poprzedni komentarz.
Authorizations:
XAuthToken
header Parameters
X-AUTH-TOKEN
required
string

Hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem.

Request Body schema: application/json
applicationId
string (Identyfikator (UUID) wniosku)
commentId
string (Identyfikator (UUID) komentarza)
date
integer (Termin dodania komentarza)
content
string (Treść komentarza)
addedBy
object (Dane twórcy komentarza)

Responses

204

Potwierdzenie otrzymania callbacka.

post /external-endpoint-onCommentAdd

Serwer testowy

https://api-demo.mikrokasa.pl//external-endpoint-onCommentAdd

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "applicationId": "string",
  • "commentId": "string",
  • "date": 0,
  • "content": "string",
  • "addedBy":
    {
    }
}

Poinformowanie o możliwości akceptacji oferty

Callback jest wysyłany gdy klient zaloguje się poprawnie przez Kontomatik celem potwierdzenia swojej tożsamości i opcjonalnie dochodu. W przypadku ofert na Pełną dokumentację daje to możliwość wysłania akceptacji oferty bez obawy o odmowę zmiany statusu ze względu na niespełnione warunki. Należy przesłać do Mikrokasy następujące informacje:

  • secret - klucz autoryzacyjny - klucz za pomocą którego aplikacja będzie wykonywała autoryzację - przykładowy klucz: SecREtZxs002#
  • external_endpoint - pełen endpoint na który będzie wysyłana informacja o statusie (np. https://integracje.firma.com/status).

Autoryzacja: W headerze w kluczu X-AUTH-TOKEN przesyłany będzie hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem. np:

  • id agencji: 0fe8c0e7-f458-4e52-ae03-d6dc15bed7c4 - identyfikator agencji, dla której należy wniosek; identyfikator ten jest przekazywany we wniosku jako partner.id.
  • secret: SecREtZxs002#
  • wynik: c524daacb87391b137244e5126a30bb0 Powiadomienie o możliwości akceptacji oferty będzie periodycznie powtarzane przez tydzień lub do czasu uzyskania odpowiedzi. Powiadomienie o kolejnym statusie jest wysyłane dopiero po otrzymaniu potwierdzenia odebrania callbacka na poprzedni status.
Authorizations:
XAuthToken
header Parameters
X-AUTH-TOKEN
required
string

Hash md5 identyfikatora agencji do której należy twórca wniosku oraz secretu ustalonego z partnerem.

Request Body schema: application/json
id
string (Identyfikator (UUID) wniosku)
status
string (Status wniosku)
Enum:"TEMPORARY" "NEW" "AUTOMATIC_ANALYSIS" "IN_ANALYSIS" "TO_FILL" "OFFER" "OFFER_ACCEPTED" "GRANTED" "ABANDONED" "REJECTED" "ACCEPTED" "TO_CORRECT" "CONFIRMED" "TO_SEND" "SENT" "RECEIVED" "RESIGNATION" "TO_PAY"

Słownik: statusy wniosku

  • TEMPORARY – Tymczasowy.
  • NEW – Nowy.
  • AUTOMATIC_ANALYSIS – W analizie automatycznej.
  • IN_ANALYSIS – W analizie.
  • TO_FILL – Do uzupełnienia przez agenta. Może wystąpić na etapie wniosku lub umowy.
  • OFFER – Oferta.
  • OFFER_ACCEPTED – Akceptacja oferty.
  • GRANTED – Przyznany.
  • ABANDONED – Rezygnacja z wniosku.
  • REJECTED – Odrzucony.
  • ACCEPTED – Umowa zaakceptowana przez Mikrokasa.
  • TO_CORRECT – Do poprawy przez Mikrokasa.
  • CONFIRMED – Potwierdzona umowa.
  • TO_SEND – Umowa do wysyłki kurierem.
  • SENT – Umowa wysłana kurierem.
  • RECEIVED – Umowa wysłana wcześniej kurierem odebrana przez klienta.
  • RESIGNATION – Rezygnacja z umowy.
  • TO_PAY – Umowa do wypłaty.
date
integer (Termin ustawienia statusu)

Responses

204

Potwierdzenie otrzymania callbacka.

post /external-endpoint-onStatusChangeEnabled

Serwer testowy

https://api-demo.mikrokasa.pl//external-endpoint-onStatusChangeEnabled

Request samples

application/json
Copy
 Expand all Collapse all
{
  • "id": "string",
  • "status": "TEMPORARY",
  • "date": 0
}