Skip to main content
GET
CheckLists GET

Authorizations

tokken
string
query
required

The unique user key of the FM entity (provided upon registration of the FM entity in the 'FinAP CheckLists' PC). Comes to the responsible person's e-mail

IDsubjectFM
string
query
required

ID of the FM subject (assigned when the FM subject is registered in the PC 'FinAP CheckLists'). Comes to the responsible person's e-mail

Query Parameters

listdata
number
default:-1

A number, each bit of which, when converted to binary format, determines the list of bases (lists) in which the search should be carried out (or the sum of numbers that correspond to the search lists)

name
string

Surname, first name, patronymic or name

namelat
string

Surname, first name, patronymic or Latin name. By default, it is generated from the name field based on the results of the transliteration algorithm

ipn
string

Individual tax number of a resident natural person (most registers do not contain data on RNOCPP), or EDRPOU of a resident legal entity

date
date

Date of birth of a natural person in the format "YYYY-MM-DD"

doc
string

Details of the document of the natural person (national passport, ID card or passport for traveling abroad) in the format of series and number, or simply number (if ID card). The presence or absence of a space between the series and the number does not matter.

doctype
number
default:0

Document type. It can take the value 1 (PASSPORT OF A CITIZEN OF UKRAINE, including an ID card), 2 (PASSPORT OF A CITIZEN OF UKRAINE FOR GOING ABROAD), 0 – both options

The method of searching for matches by registers (1 — full-text (default), 2 — with error correction)

lowranklimit
number
default:0

A number that defines the lower limit of name or surname matches in percentage

Response

Successful response

idinternal
string

The internal unique ID of the request, which is generated by means of the internal software of the FM subject

idsubjectFM
string

ID of the FM entity (provided when registering the FM entity in the PC 'FinAP CheckLists')

iduserPC
string

ID of the workplace of the FM subject (provided on the side of the FM subject)

idrequest
string

Request identifier in the PC system 'FinAP CheckLists' (generated by the Request Processing Service)

dateResponse
string

Date and time of the response (generated by the Request Processing Service) in the format 'YYYY-MM-DD hh:mm:ss'

listdata
string

A number that, when converted to binary format, shows which data lists were searched for matches

Search method (1 — full-text, 2 — contextual...)

responsetype
string

Type of response (request result): 1 — response-permission (true|false); 2 – generalized; 3 — shortened; 5 — full;

textformat
string

The text field format for the full response type (responsetype=5), can take the values ​​'JSON' (or ' ', by default), 'xml', 'html' and 'text'

result
Response block from registers · object

Block of results of processing a request to CheckLists registers