Wbuduj screening sankcyjny, PEP, list przestępczych, negatywnych mediów oraz KYB/UBO wprost w swoje procesy onboardingu, monitoringu i transakcji. API już działa: uwierzytelnij się kluczem API i wywołaj ten sam silnik screeningowy, z którego korzysta portal.
API v1 już działa
Endpointy są ogólnodostępne, z uwierzytelnianiem kluczem API i limitami zapytań według poziomu. Poznaj każdy endpoint w interaktywnej dokumentacji OpenAPI pod adresem /api/v1/docs.
Tworzy żądanie screeningu dla jednego podmiotu. Zwraca identyfikator wyszukiwania i status przetwarzania. W ramach /api/v1 dostępne są także endpointy konta, zakresu danych i stanu usługi.
Uwierzytelnianie: X-API-Key (search:write)
EP 02ENDPOINT
POST /api/v1/batch
Przesyłaj pliki CSV/XLSX do screeningu na dużą skalę, a po zakończeniu zadań pobieraj wiersze lub eksporty.
Uwierzytelnianie: X-API-Key (batch:write)
EP 03ENDPOINT
POST /api/v1/keys
Twórz poświadczenia API i zarządzaj nimi — z uprawnieniami o ograniczonym zakresie, limitami zapytań zależnymi od poziomu i śledzeniem zużycia.
Uwierzytelnianie: token Bearer (konto)
§03Dlaczego zespoły korzystają z API
03 / 05
Jedna integracja dla screeningu sankcyjnego, PEP, list przestępczych, negatywnych mediów oraz KYB/UBO
Uwierzytelnianie kluczem API przez nagłówek X-API-Key, z kluczami o ograniczonym zakresie dla dostępu na zasadzie minimalnych uprawnień
Limity zapytań według poziomu z logowaniem zużycia na potrzeby nadzoru i kontroli kosztów
Endpointy wyszukiwania, wsadowe, kluczy, konta, zakresu danych i stanu usługi w ramach /api/v1
Interaktywna dokumentacja OpenAPI pod /api/v1/docs oraz maszynowo czytelny schemat OpenAPI
Ustrukturyzowany wynik odpowiedni do logów audytowych, akt spraw i dalszych decyzji
Żądania screeningu do /api/v1/search i /api/v1/batch uwierzytelniasz kluczem API przesyłanym w nagłówku X-API-Key. Klucze twórz w panelu albo programowo przez /api/v1/keys, po uwierzytelnieniu się tokenem bearer swojego konta.
Q02
Czy API jest ogólnodostępne?
Tak. API v1 działa i jest ogólnodostępne. Uwierzytelnij się kluczem API, wywołuj endpointy wyszukiwania, wsadowe i zarządzania kluczami, a wszystko poznasz w interaktywnej dokumentacji OpenAPI pod /api/v1/docs.
Q03
Czy mogę ograniczyć zakres uprawnień klucza API?
Tak. Klucze obsługują uprawnienia takie jak search:read, search:write, batch:read i batch:write, dzięki czemu wymusisz dostęp na zasadzie minimalnych uprawnień dla każdej integracji.
Q04
Jakie limity zapytań obowiązują?
Limity zapytań są przypisywane według poziomu API i egzekwowane na klucz API — poziom określa przepustowość żądań, a nie rozliczenia. Nagłówki odpowiedzi zawierają limit, pozostały przydział i znaczniki czasu resetu, dzięki czemu możesz płynnie ograniczyć tempo żądań.
Q05
Gdzie mogę szybko przetestować endpointy?
Skorzystaj z interaktywnej dokumentacji pod /api/v1/docs do testów w Swaggerze oraz /api/v1/redoc dla dokumentacji w stylu referencyjnym. Schemat OpenAPI jest udostępniany pod /api/v1/openapi.json.