> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fin-observe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Request Parameters

> Data required to build a request

## API Servers

* checklists.fin-observe.com
* res1-checklists.fin-observe.com
* res2-checklists.fin-observe.com

## Request Type

* [GET](/en/check-lists/checklists-get)
* [POST](/en/check-lists/checklists-post)

## Input Parameters

### Required

<ParamField query="IDsubjectFM" body="IDsubjectFM" type="string" required>
  ID of the financial monitoring entity (assigned during registration of the financial monitoring entity in the “FinAP CheckLists” system). Sent to the email address of the responsible person.
</ParamField>

<ParamField query="tokken" body="tokken" type="string" required>
  Unique user key of the financial monitoring entity (assigned during registration of the financial monitoring entity in the “FinAP CheckLists” system). Sent to the email address of the responsible person.
</ParamField>

### Main

<ParamField query="name" body="name" type="string">
  Surname, first name, patronymic, or entity name
</ParamField>

<ParamField query="ipn" body="ipn" type="string">
  Individual tax number of a resident individual (most registers do not contain data on RNOKPP), or EDRPOU code of a resident legal entity
</ParamField>

<ParamField query="date" body="date" type="date" placeholder="YYYY-MM-DD">
  Date of birth of an individual in the format “YYYY-MM-DD”
</ParamField>

<ParamField query="doc" body="doc" type="string">
  Individual’s document details (national passport, ID card, or passport for travel abroad) in the format series and number, or number only (for ID card). The presence or absence of a space between the series and the number does not matter.
</ParamField>

### Additional

<ParamField query="IDinternal" body="IDinternal" type="string">
  Internal unique request ID (generated on the side of the financial monitoring entity)
</ParamField>

<ParamField query="DateRequest" body="DateRequest" type="datetime">
  Date and time of request generation (generated on the side of the financial monitoring entity) in the format “YYYY-MM-DD hh:mm:ss”
</ParamField>

<ParamField query="IDuserPC" body="IDuserPC" type="string">
  ID of the workstation of the financial monitoring entity (assigned on the side of the financial monitoring entity)
</ParamField>

<ParamField query="listdata" body="listdata" default="-1" type="numeric">
  A number whose each bit, when converted to binary format, determines the list of databases (lists) in which the search must be performed (or the sum of numbers corresponding to search lists). For example, for searching in active sanction lists, “listdata”: 127 — “0000 0000 0000 0111 1111”. See Table 2. By default, the value corresponding to a request across all service registers is used.
</ParamField>

<ParamField query="search" body="search" default="1" type="numeric">
  Match search method across registers (1 — full-text (default), 2 — with error correction). Default is 1.
</ParamField>

<ParamField query="lowranklimit" body="lowranklimit" default="0" type="numeric">
  A number defining the lower threshold of name or full name matches in percent
</ParamField>

<ParamField query="namelat" body="namelat" type="string">
  Surname, first name, patronymic, or name in Latin script. By default, it is generated from the name field using the transliteration algorithm.
</ParamField>

<ParamField query="nonrezedentcode" body="nonrezedentcode" type="string">
  Non-resident code
</ParamField>

<ParamField query="city" body="city" type="string">
  Name of the locality. Used to search for entrepreneurs in the Register of Legal Entities and Individual Entrepreneurs by place of registration, as well as in the tax debtors register by tax authority affiliation.
</ParamField>

<ParamField query="doctype" body="doctype" default="0" type="numeric">
  Document type. Possible values: 1 (Passport of a Citizen of Ukraine, including ID card), 2 (Passport of a Citizen of Ukraine for travel abroad), 0 — both types. Default is 0.
</ParamField>

<ParamField query="edrchangesfrom" body="edrchangesfrom" default="1991-08-24" type="date">
  Start date of the period of changes in the EDR (for analysis) in the format “YYYY-MM-DD”
</ParamField>

<ParamField query="edrchangesto" body="edrchangesto" default="now()" type="date">
  End date of the period of changes in the EDR (for analysis) in the format “YYYY-MM-DD”
</ParamField>

<ParamField query="arrayedrpou" body="arrayedrpou" type="string[]">
  List (array) of EDRPOU codes for which changes in the EDR are analyzed during the specified period
</ParamField>

<ParamField query="onlyactual" body="onlyactual" default="true" type="boolean">
  This parameter specifies whether to return only the current record or all records available in the register (true — current only, false — all). Default is current only.
</ParamField>