Skip to main content
POST
CheckLists POST

Treść

application/json
tokken
string
wymagane

Unikalny klucz użytkownika podmiotu FM (przyznawany podczas rejestracji podmiotu FM w systemie 'FinAP CheckLists'). Wysyłany na adres e-mail osoby odpowiedzialnej

IDsubjectFM
string
wymagane

ID podmiotu FM (przypisywane podczas rejestracji podmiotu FM w systemie 'FinAP CheckLists'). Wysyłane na adres e-mail osoby odpowiedzialnej

listdata
number

Liczba, której każdy bit po konwersji na format binarny określa listę baz (list), w których ma zostać przeprowadzone wyszukiwanie (lub suma liczb odpowiadających listom wyszukiwania).

name
string

Nazwisko, imię, imię ojca lub nazwa

namelat
string

Nazwisko, imię, imię ojca lub nazwa w alfabecie łacińskim. Domyślnie generowane z pola name na podstawie wyników algorytmu transliteracji

ipn
string

Indywidualny numer podatkowy osoby fizycznej – rezydenta (większość rejestrów nie zawiera danych o RNOCPP) lub EDRPOU osoby prawnej – rezydenta

date
date

Data urodzenia osoby fizycznej w formacie 'YYYY-MM-DD'

doc
string

Dane dokumentu osoby fizycznej (paszport krajowy, karta ID lub paszport do wyjazdu za granicę) w formacie serii i numeru lub tylko numeru (jeśli karta ID). Obecność lub brak spacji między serią a numerem nie ma znaczenia.

doctype
number

Typ dokumentu. Może przyjmować wartość 1 (PASZPORT OBYWATELE UKRAINY, w tym karta ID), 2 (PASZPORT OBYWATELE UKRAINY DO WYJAZDU ZA GRANICĘ), 0 – obie opcje. Domyślnie – 0

Metoda wyszukiwania zgodności w rejestrach (1 — pełnotekstowy (domyślny), 2 — z korekcją błędów). Domyślnie – 1

lowranklimit
number

Liczba określająca dolny limit zgodności nazwy lub danych osobowych w procentach

Odpowiedź

Pomyślna odpowiedź

Schemat odpowiedzi na żądanie do serwisu CheckLists

idinternal
string

Wewnętrzny unikalny ID żądania generowany przez wewnętrzne oprogramowanie podmiotu FM

idsubjectFM
string

ID podmiotu FM (przypisywane podczas rejestracji podmiotu FM w systemie 'FinAP CheckLists')

iduserPC
string

ID stanowiska pracy podmiotu FM (przypisywane po stronie podmiotu FM)

idrequest
string

Identyfikator żądania w systemie 'FinAP CheckLists' (generowany przez Serwis obsługi żądań)

dateResponse
string

Data i czas wygenerowania odpowiedzi (tworzona przez Serwis obsługi żądań) w formacie 'YYYY-MM-DD hh:mm:ss'

listdata
string

Liczba, która w formacie binarnym pokazuje, w których listach danych wyszukano dopasowania

Metoda wyszukiwania (1 — pełnotekstowa, 2 — kontekstowa...)

responsetype
string

Typ odpowiedzi (wyniku żądania): 1 — odpowiedź-zgoda (true|false); 2 – uogólniony; 3 — skrócony; 5 — pełny;

textformat
string

Format pola tekstowego dla pełnego typu odpowiedzi (responsetype=5), może przyjmować wartości 'JSON' (lub ' ', domyślnie), 'xml', 'html' i 'text'

result
Blok odpowiedzi z rejestrów · object

Blok wyników przetwarzania żądania w rejestrach CheckLists