Skip to main content
GET
CheckLists GET

Autoryzacje

tokken
string
query
wymagane

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

IDsubjectFM
string
query
wymagane

ID podmiotu FM (przyznawany podczas rejestracji podmiotu FM w 'CheckLists'). Wysyłany na adres e-mail osoby odpowiedzialnej

Parametry zapytania

listdata
number
domyślnie:-1

Liczba, której każdy bit po przekształceniu do formatu binarnego określa listę baz (list), w których należy przeprowadzić wyszukiwanie (lub sumę 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 działania algorytmu transliteracji

ipn
string

Indywidualny numer podatkowy osoby fizycznej - rezydenta (większość rejestrów nie zawiera danych o RNOCPP), lub EDRPOU osoby prawnej będącej rezydentem

date
date

Data urodzenia osoby fizycznej w formacie “YYYY-MM-DD”

doc
string

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

doctype
number
domyślnie:0

Typ dokumentu. Może przyjmować wartości 1 (PASZPORT OBYWATELA UKRAINY, w tym karta ID), 2 (PASZPORT OBYWATELA UKRAINY NA WYJAZD ZA GRANICĘ), 0 – oba warianty

Metoda wyszukiwania dopasowań w rejestrach (1 — pełnotekstowy (domyślnie), 2 — z korekcją błędów)

lowranklimit
number
domyślnie:0

Liczba określająca dolną granicę dopasowań nazwy lub imienia w procentach

Odpowiedź

Pomyślna odpowiedź

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