Skip to main content
POST
/
api
CheckLists POST
curl --request POST \
  --url 'https://checklists.fin-observe.com/api?tokken=&IDsubjectFM=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tokken": "<string>",
  "IDsubjectFM": "<string>",
  "listdata": 123,
  "name": "<string>",
  "namelat": "<string>",
  "ipn": "<string>",
  "date": "<unknown>",
  "doc": "<string>",
  "doctype": 123,
  "search": 123,
  "lowranklimit": 123
}
'
{
  "idinternal": "<string>",
  "idsubjectFM": "<string>",
  "iduserPC": "<string>",
  "idrequest": "<string>",
  "dateResponse": "<string>",
  "listdata": "<string>",
  "search": "<string>",
  "responsetype": "<string>",
  "textformat": "<string>",
  "result": {
    "peps": [
      {
        "list": "<string>",
        "idpep": 123,
        "active": true,
        "name": "<string>",
        "aka": "<string>",
        "type": 123,
        "dateb": "<string>",
        "yearb": "<string>",
        "dateendpep": "<string>",
        "pependcomment": "<string>",
        "job": "<string>",
        "region": "<string>",
        "country": {},
        "ipn": "<string>",
        "photo": "<string>",
        "categoryPEP": "<string>",
        "typePEP": 123,
        "descriptiontypePEP": "<string>",
        "foreign_relation": true,
        "percent": 123,
        "level": "<string>",
        "sources": [
          {
            "site": "<string>",
            "pdf": "<string>",
            "brief": "<string>"
          }
        ],
        "declarations": [
          {
            "d_name": "<string>",
            "d_year": "<string>",
            "d_link": "<string>",
            "d_pdf": "<string>"
          }
        ],
        "jobdetails": [
          {
            "jobplace": "<string>",
            "jobbegin": "<string>",
            "jobend": "<string>",
            "jobpost": "<string>",
            "jobedrpou": "<string>",
            "jobcountry": {},
            "links": [
              {
                "site": "<string>",
                "pdf": "<string>",
                "brief": "<string>"
              }
            ]
          }
        ],
        "relatedPersons": [
          {
            "relateid": 123,
            "active": true,
            "relatepib": "<string>",
            "relateaka": "<string>",
            "relatetype": 123,
            "country": {},
            "relatedatebith": "<string>",
            "relatebrief": "<string>",
            "relatebrief_id": 123,
            "relatelink": 123,
            "relatecod": "<string>",
            "relateorg": "<string>",
            "archivelink": true
          }
        ],
        "relatedPeps": [
          {
            "idpep": 123,
            "active": true,
            "namerpep": "<string>",
            "akarpep": "<string>",
            "type": 123,
            "country": {},
            "datebirthpep": "<string>",
            "categoryrpep": "<string>",
            "descriptiontyperpep": "<string>",
            "briefrpep": "<string>",
            "linkrpep": 123,
            "photorpep": "<string>",
            "jobrpep": "<unknown>",
            "relateorg": "<string>",
            "archivelink": true,
            "links": [
              {
                "site": "<string>",
                "pdf": "<string>",
                "brief": "<string>"
              }
            ]
          }
        ]
      }
    ],
    "psanctions": [
      {
        "pid": "<string>",
        "active": true,
        "p_active": "<string>",
        "s_type": 123,
        "p_fullname": "<string>",
        "p_akas": [
          "<string>"
        ],
        "p_type": 123,
        "p_birthdate": "<string>",
        "p_birthdates": [
          "<string>"
        ],
        "p_birthplaces": [
          "<string>"
        ],
        "p_address": [
          "<string>"
        ],
        "p_photo": "<string>",
        "p_comment": "<string>",
        "p_country": 123,
        "country": {},
        "p_countries": [
          "<string>"
        ],
        "p_idcode": [
          "<string>"
        ],
        "p_docs": [
          "<string>"
        ],
        "p_lists": "<string>",
        "p_listdata": 123,
        "sanction": [
          {
            "sanctionId": "<string>",
            "list": "<string>",
            "list_info": {
              "list": "<string>",
              "name": "<string>",
              "altname": "<string>",
              "territory": "<string>",
              "cca2": "<string>",
              "publisher": "<string>",
              "individual": 123,
              "entity": 123,
              "all": 123,
              "loadDate": "<string>",
              "description": "<string>",
              "source": "<string>",
              "listDate": "<string>",
              "list_type": 123
            },
            "name": "<string>",
            "address": "<string>",
            "doc": "<string>",
            "birthdayDate": "<string>",
            "aka": "<string>",
            "birthdayPlace": "<string>",
            "citizenship": "<string>",
            "entityType": "<string>",
            "gender": "<string>",
            "insertDate": "<string>",
            "lastModifyDate": "<string>",
            "nationality": "<string>",
            "originalName": "<string>",
            "position": "<string>",
            "remark": "<string>",
            "source": "<string>",
            "title": "<string>",
            "vessel": "<string>",
            "work": "<string>",
            "period": "<string>",
            "related": 123,
            "percent": 123,
            "level": "<string>",
            "sanctionSource": {
              "norder": "<string>",
              "dateorder": "<string>",
              "weblink": "<string>"
            }
          }
        ],
        "sanction_lost": [
          {
            "sanctionId": "<string>",
            "list": "<string>",
            "list_info": {
              "list": "<string>",
              "name": "<string>",
              "altname": "<string>",
              "territory": "<string>",
              "cca2": "<string>",
              "publisher": "<string>",
              "individual": 123,
              "entity": 123,
              "all": 123,
              "loadDate": "<string>",
              "description": "<string>",
              "source": "<string>",
              "listDate": "<string>",
              "list_type": 123
            },
            "name": "<string>",
            "address": "<string>",
            "doc": "<string>",
            "birthdayDate": "<string>",
            "aka": "<string>",
            "birthdayPlace": "<string>",
            "citizenship": "<string>",
            "entityType": "<string>",
            "gender": "<string>",
            "insertDate": "<string>",
            "lastModifyDate": "<string>",
            "nationality": "<string>",
            "originalName": "<string>",
            "position": "<string>",
            "remark": "<string>",
            "source": "<string>",
            "title": "<string>",
            "vessel": "<string>",
            "work": "<string>",
            "period": "<string>",
            "related": 123,
            "percent": 123,
            "level": "<string>",
            "sanctionSource": {
              "norder": "<string>",
              "dateorder": "<string>",
              "weblink": "<string>"
            }
          }
        ],
        "caution": [
          {
            "sanctionId": "<string>",
            "list": "<string>",
            "list_info": {
              "list": "<string>",
              "name": "<string>",
              "altname": "<string>",
              "territory": "<string>",
              "cca2": "<string>",
              "publisher": "<string>",
              "individual": 123,
              "entity": 123,
              "all": 123,
              "loadDate": "<string>",
              "description": "<string>",
              "source": "<string>",
              "listDate": "<string>",
              "list_type": 123
            },
            "name": "<string>",
            "address": "<string>",
            "doc": "<string>",
            "birthdayDate": "<string>",
            "aka": "<string>",
            "birthdayPlace": "<string>",
            "citizenship": "<string>",
            "entityType": "<string>",
            "gender": "<string>",
            "insertDate": "<string>",
            "lastModifyDate": "<string>",
            "nationality": "<string>",
            "originalName": "<string>",
            "position": "<string>",
            "remark": "<string>",
            "source": "<string>",
            "title": "<string>",
            "vessel": "<string>",
            "work": "<string>",
            "period": "<string>",
            "related": 123,
            "percent": 123,
            "level": "<string>",
            "sanctionSource": {
              "norder": "<string>",
              "dateorder": "<string>",
              "weblink": "<string>"
            }
          }
        ],
        "caution_lost": [
          {
            "sanctionId": "<string>",
            "list": "<string>",
            "list_info": {
              "list": "<string>",
              "name": "<string>",
              "altname": "<string>",
              "territory": "<string>",
              "cca2": "<string>",
              "publisher": "<string>",
              "individual": 123,
              "entity": 123,
              "all": 123,
              "loadDate": "<string>",
              "description": "<string>",
              "source": "<string>",
              "listDate": "<string>",
              "list_type": 123
            },
            "name": "<string>",
            "address": "<string>",
            "doc": "<string>",
            "birthdayDate": "<string>",
            "aka": "<string>",
            "birthdayPlace": "<string>",
            "citizenship": "<string>",
            "entityType": "<string>",
            "gender": "<string>",
            "insertDate": "<string>",
            "lastModifyDate": "<string>",
            "nationality": "<string>",
            "originalName": "<string>",
            "position": "<string>",
            "remark": "<string>",
            "source": "<string>",
            "title": "<string>",
            "vessel": "<string>",
            "work": "<string>",
            "period": "<string>",
            "related": 123,
            "percent": 123,
            "level": "<string>",
            "sanctionSource": {
              "norder": "<string>",
              "dateorder": "<string>",
              "weblink": "<string>"
            }
          }
        ]
      }
    ],
    "lostdocs": [
      {
        "ovd": "<string>",
        "d_SERIES": "<string>",
        "d_NUMBER": "<string>",
        "d_TYPE": "<string>",
        "d_STATUS": "<string>",
        "theft_DATA": "<string>",
        "insert_DATE": "<string>",
        "id": "<string>"
      }
    ],
    "edr": [
      {
        "idrec": 123,
        "edrpou": "<string>",
        "name": "<string>",
        "shortname": "<string>",
        "address": "<string>",
        "manager": "<string>",
        "kved": "<string>",
        "state": "<string>",
        "txtf": "<string>",
        "kbv": "<string>",
        "mng": "<string>",
        "own": "<string>",
        "isbilorussian": true,
        "isrussian": true,
        "isriskbonds": true,
        "isnoprofit": true,
        "ispep": true,
        "isactualpep": true,
        "issan": true,
        "isactualsan": true,
        "indicators": 123,
        "indicators_str": "<string>",
        "indicators_note": "<string>",
        "indicators_level": 123,
        "level": "<string>"
      }
    ],
    "edrfullinfo": [
      {
        "idrec": 123,
        "type": 123,
        "branchstate": "<string>",
        "edrpou": "<string>",
        "name": "<string>",
        "shortName": "<string>",
        "altname": "<string>",
        "address": "<string>",
        "stan": "<string>",
        "fdn": "<string>",
        "opf": "<string>",
        "sm": "<string>",
        "authorizedCapital": "<string>",
        "statute": "<string>",
        "registration": "<string>",
        "managingPaper": "<string>",
        "terminatedInfo": "<string>",
        "terminationCancelInfo": "<string>",
        "ca": "<string>",
        "vpDates": "<string>",
        "contacts": "<string>",
        "address_mreg": 123,
        "edrpou_address_mreg": "<string>",
        "isnoprofit": true,
        "isriskbonds": true,
        "n_mfounder": 123,
        "mfounder_edrpou": "<string>",
        "isbilorussian": true,
        "isrussian": true,
        "date_last_changed": "<string>",
        "indicators": 123,
        "indicators_str": "<string>",
        "indicators_note": "<string>",
        "indicators_level": 123,
        "percent": 123,
        "level": "<string>",
        "founders": [
          {
            "founder": "<string>",
            "name": "<string>",
            "edrpou": "<string>",
            "indicators": 123,
            "indicators_str": "<string>",
            "indicators_note": "<string>",
            "indicators_level": 123,
            "part_suma": 123,
            "percent": 123,
            "n_pep": 123,
            "is_actual_pep": true,
            "n_pep_ids": "<string>",
            "n_san": 123,
            "is_actual_san": true,
            "n_san_ids": "<string>",
            "n_psan_ids": "<string>",
            "n_fop": true,
            "n_fop_ids": "<string>",
            "n_founder": "<string>",
            "rel_edrpou": "<string>",
            "address_founder": "<string>",
            "name_adr_founder": "<string>",
            "edrpou_adr_founder": "<string>",
            "country_of_origin": "<string>",
            "country_of_origin_risks": {},
            "country_of_register": "<string>",
            "country_of_register_risks": {}
          }
        ],
        "benefiaciars": [
          {
            "founder": "<string>",
            "pib_name": "<string>",
            "name": "<string>",
            "edrpou": "<string>",
            "indicators": 123,
            "indicators_str": "<string>",
            "indicators_note": "<string>",
            "indicators_level": 123,
            "address_f": "<string>",
            "type": 123,
            "role": "<string>",
            "interest": 123,
            "indirect_interest": 123,
            "reason": "<string>",
            "other_impact": "<string>",
            "beneficiary_false": true,
            "n_pep": 123,
            "is_actual_pep": true,
            "n_pep_ids": "<string>",
            "n_san": 123,
            "is_actual_san": true,
            "n_san_ids": "<string>",
            "n_psan_ids": "<string>",
            "n_fop": true,
            "n_fop_ids": "<string>",
            "n_mb": "<string>",
            "rel_edrpou": "<string>",
            "address_mb": "<string>",
            "name_adr_mb": "<string>",
            "edrpou_adr_mb": "<string>",
            "country_of_origin": "<string>",
            "country_of_origin_risks": {},
            "country_of_register": "<string>",
            "country_of_register_risks": {}
          }
        ],
        "manager_info": {
          "name": "<string>",
          "position": "<string>",
          "appointment_date": "<string>",
          "restriction": "<string>",
          "m_pep": "<string>",
          "m_pep_ids": "<string>",
          "is_actual_pep": true,
          "m_san": "<string>",
          "m_san_ids": "<string>",
          "m_psan_ids": "<string>",
          "is_actual_san": true
        },
        "signers": [
          {
            "founder": "<string>",
            "name": "<string>",
            "position": "<string>",
            "appointment_date": "<string>",
            "restriction": "<string>",
            "m_pep": "<string>",
            "m_pep_ids": "<string>",
            "is_actual_pep": true,
            "m_san": "<string>",
            "m_san_ids": "<string>",
            "m_psan_ids": "<string>",
            "is_actual_san": true
          }
        ],
        "eps": [
          {
            "name": "<string>",
            "code": "<string>"
          }
        ],
        "aks": [
          {
            "name": "<string>",
            "code": "<string>",
            "prima": "<string>"
          }
        ],
        "assignees": [
          {
            "name": "<string>",
            "code": "<string>"
          }
        ],
        "predecs": [
          {
            "name": "<string>",
            "code": "<string>"
          }
        ],
        "bankrupts": [
          {
            "opDate": "<string>",
            "reason": "<string>",
            "sbjState": "<string>",
            "justmentName": "<string>"
          }
        ],
        "tsi": [
          {
            "opDate": "<string>",
            "reason": "<string>",
            "sbjState": "<string>",
            "signerName": "<string>",
            "creditorReqEndDate": "<string>"
          }
        ],
        "exdatas": [
          {
            "authorityName": "<string>",
            "authorityCode": "<string>",
            "taxPayType": "<string>",
            "startDate": "<string>",
            "startNum": "<string>",
            "endDate": "<string>",
            "endNum": "<string>"
          }
        ],
        "branches": [
          {
            "code": "<string>",
            "name": "<string>",
            "address": "<string>",
            "signer": "<string>",
            "createDate": "<string>",
            "contacts": "<string>",
            "indicators": 123,
            "indicators_str": "<string>",
            "indicators_note": "<string>",
            "indicators_level": 123,
            "aks": [
              {
                "name": "<string>",
                "code": "<string>",
                "prima": "<string>"
              }
            ],
            "exdata": [
              {
                "authorityName": "<string>",
                "authorityCode": "<string>",
                "taxPayType": "<string>",
                "startDate": "<string>",
                "startNum": "<string>",
                "endDate": "<string>",
                "endNum": "<string>"
              }
            ]
          }
        ]
      }
    ],
    "edrchanges": [
      {
        "edrchangesfrom": "<string>",
        "edrchangesto": "<string>",
        "edrchanges": [
          {
            "edrpou": "<string>",
            "lastname": "<string>",
            "lastsname": "<string>",
            "lastaddress": "<string>",
            "laststate": "<string>",
            "n_name": "<string>",
            "n_address": "<string>",
            "n_manag": "<string>",
            "n_kved": "<string>",
            "n_state": "<string>",
            "n_kbv": "<string>",
            "n_kbv_human": "<string>",
            "n_founder": "<string>",
            "n_founder_human": "<string>",
            "changes": [
              {
                "datachange": "<string>",
                "changedetails": [
                  {
                    "id": "<string>",
                    "changeinf": "<string>",
                    "changetype": 123,
                    "ishumanchanges": true,
                    "oldv": "<string>",
                    "newv": "<string>"
                  }
                ]
              }
            ]
          }
        ]
      }
    ],
    "justice": [
      {
        "cause_num": "<string>",
        "name": "<string>",
        "edrpou": "<string>",
        "typeperson": "<string>",
        "nameperson": "<string>",
        "case_description": "<string>",
        "datails": "<string>",
        "documents": [
          {
            "doc_id": "<string>",
            "court": "<string>",
            "instance": "<string>",
            "judgment_form": "<string>",
            "judge": "<string>",
            "cause_categorie": "<string>",
            "adjudication_date": "<string>",
            "doc_url": "<string>"
          }
        ],
        "persons": "<string>",
        "personsList": [
          {
            "type": "<string>",
            "name": "<string>",
            "court": "<string>",
            "date": "<string>"
          }
        ],
        "percent": 123,
        "level": "<string>"
      }
    ],
    "licenses": [
      {
        "edrpou": "<string>",
        "build": [
          {
            "id": 123,
            "vud": "<string>",
            "lic": "<string>",
            "name": "<string>",
            "address": "<string>",
            "datebegin": "<string>",
            "dateend": "<string>"
          }
        ],
        "gambling": [
          {
            "name": "<string>",
            "address": "<string>",
            "license": "<string>",
            "datelicense": "<string>",
            "brandname": "<string>",
            "ntypelic": 123,
            "typelic": "<string>",
            "description": "<string>"
          }
        ],
        "bonds": [
          {
            "id": 123,
            "sertificates_nom": "<string>",
            "edrpou": "<string>",
            "entity_form": "<string>",
            "name": "<string>",
            "emis_type_name": "<string>",
            "qty": 123,
            "nominal": 123,
            "emis_vol": 123,
            "stat_cap": 123,
            "releases_form_code": "<string>",
            "tp_name": "<string>",
            "reg_date": "<string>",
            "report_reg_dt": "<string>",
            "suspend_nom": "<string>",
            "suspend_dt": "<string>",
            "resume_nom": "<string>",
            "resume_dt": "<string>",
            "cancel_nom": "<string>",
            "series": "<string>"
          }
        ]
      }
    ],
    "executive": [
      {
        "order_vp": 123,
        "devtor_edrpou": "<string>",
        "debtor_name": "<string>",
        "debtor_birtdate": "<string>",
        "creditor_edrpou": "<string>",
        "creditor_name": "<string>",
        "begindate_vp": "<string>",
        "state_vp": "<string>",
        "depname": "<string>",
        "typecl": "<string>",
        "dvs": "<string>",
        "phone_num": "<string>",
        "email": "<string>",
        "bank_account": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "taxdebtor": [
      {
        "dname": "<string>",
        "dedrpou": "<string>",
        "ddirname": "<string>",
        "dfs": [
          {
            "ddfsname": "<string>",
            "debtdetails": [
              {
                "dminperiod": 123,
                "dmaxperiod": 123,
                "dsumlocal": 123,
                "dsumgov": 123,
                "dsumesv": 123,
                "disactive": 123
              }
            ]
          }
        ]
      }
    ],
    "debtor": [
      {
        "vporder": "<string>",
        "name": "<string>",
        "birthdate": "<string>",
        "code": "<string>",
        "publisher": "<string>",
        "emp_fio": "<string>",
        "emp_org": "<string>",
        "emp_phone": "<string>",
        "org_phone": "<string>",
        "email": "<string>",
        "vd_cat": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "okupant": [
      {
        "id": 123,
        "name": "<string>",
        "rank": "<string>",
        "birth": "<string>",
        "passport": "<string>",
        "basenumber": "<string>",
        "base": "<string>",
        "info": "<string>",
        "locatedinua": true,
        "is_good": true,
        "is_polon": true,
        "is_identified": true,
        "is_accused": true,
        "foto": "<string>",
        "address": "<string>",
        "link": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "zrada": [
      {
        "id": "<string>",
        "name": "<string>",
        "birth": "<string>",
        "position": "<string>",
        "reason": "<string>",
        "foto": "<string>",
        "url": "<string>",
        "source": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "nonrezedent": [
      {
        "code": "<string>",
        "name": "<string>",
        "date_reestr": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "notarius": [
      {
        "license": "<string>",
        "name": "<string>",
        "nameobj": "<string>",
        "region": "<string>",
        "contacts": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ],
    "bankrupt": [
      {
        "edrpou": "<string>",
        "name": "<string>",
        "details": [
          {
            "id": 123,
            "daterec": "<string>",
            "typerec": "<string>",
            "casenumber": "<string>",
            "startdateauc": "<string>",
            "enddateauc": "<string>",
            "courtname": "<string>",
            "endregistrdate": "<string>"
          }
        ],
        "percent": 123,
        "level": "<string>"
      }
    ],
    "wanted": [
      {
        "id": "<string>",
        "list": "<string>",
        "name": "<string>",
        "father_name": "<string>",
        "mother_name": "<string>",
        "mothers_maiden_name": "<string>",
        "pseudonim": "<string>",
        "last_residence": "<string>",
        "aka": "<string>",
        "datebirth": "<string>",
        "foto": "<string>",
        "fotos": [
          "<string>"
        ],
        "color": "<string>",
        "forename": "<string>",
        "weight": 123,
        "height": 123,
        "hairs_id": [
          "<string>"
        ],
        "country_of_birth_id": "<string>",
        "place_of_birth": "<string>",
        "nationalities": [
          "<string>"
        ],
        "languages_spoken_ids": [
          "<string>"
        ],
        "eyes_colors_id": [
          "<string>"
        ],
        "arrest_warrants": [
          {
            "charge": "<string>",
            "issuing_country_id": "<string>",
            "charge_translation": "<string>"
          }
        ],
        "links": [
          {}
        ],
        "distinguishing_marks": "<string>",
        "thumbnail": "<string>",
        "gender": "<string>",
        "date_disappearance": "<string>",
        "place_disappearance": "<string>",
        "precaution": "<string>",
        "article_accusation": "<string>",
        "contacts": "<string>",
        "region": "<string>",
        "category": "<string>",
        "last_actual_date": "<string>",
        "actual": true,
        "percent": 123,
        "level": "<string>"
      }
    ],
    "corrupt": [
      {
        "id": 123,
        "entity": "<string>",
        "name": "<string>",
        "punishment_type": "<string>",
        "punishment_start": "<string>",
        "punishment": "<string>",
        "sentence_date": "<string>",
        "offense_name": "<string>",
        "court_case_number": "<string>",
        "court_name": "<string>",
        "sentence_number": "<string>",
        "codex_articles": "<string>",
        "percent": 123,
        "level": "<string>"
      }
    ]
  }
}

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

Body

application/json
​
tokken
string
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
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

​
listdata
number

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 title

​
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

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 default is 0

​
search
number

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

​
lowranklimit
number

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

Response

Successful response

Scheme of response to a request to the CheckLists service

​
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
string

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