Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Request JSON
( **the parameters are transferred optionally if there is a credit history for this client from your organization)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)/EDRPOU (for legal entities)",

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

"contacts": {

"cont": {

"ctype": "**Contact type (code from ref.10)",

"cval": "**Contact value"

}

},

"docs": {

"doc": {

"dtype": "**Document type (code from ref.7)",

"dser": "**Document series",

"dnom": "**Document number"

}

},

"reqlng": "Search criteria language (code from ref.23)"

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'Contacts' report – 04",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

...

Response XML

Expand
titlebody:

<?xml version="1.0" encoding="utf-8"?>

<ubkidata>

<!-- System information part -->

<tech>

<trace>

<step name="Step name" stm="Step start stamp date" ftm="Step finish stamp date">

<!-- The trace part contains timing metrics of components generation steps -->

</step>

</trace>

<error errtype="Error code (code from ref.0)" errtext="Error text (value from ref.0)">

</error>

<reqinfo reqid="Outgoing request ID generated by UBKI">

</reqinfo>

<!-- Information about the current status of the prepaid account part-->

<billing>

<balance value="Total assets" date="Date" time="Time" />

</billing>

</tech>

<!-- Identification part -->

<comp id="1" descr="Names of components">

<cki inn="TIN of the credit history subject/EDRPOU of the legal entity"

lname="Last name/Name of the legal entity"

fname="First name"

mname="Middle name"

reqlng="Search language (while searching)/Identification language (during transfer) (code from ref.23)"

reqlngref="Search language (while searching)/Identification language (during transfer) (value from ref.23)"

bdate="Date of birth">

<ident donor="Source of information (code from ref. 54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

inn="TIN of the credit history subject"

lname="Last name"

fname="First name"

mname="Middle name"

bdate="Date of birth"

csex="Sex (code from ref.1)"

csexref="Sex (value from ref.1)"

family="Marital status (code from ref.2)"

familyref="Marital status (value from ref.2)"

ceduc="Education (code from ref.3)"

ceducref="Education (value from ref.3)"

cgrag="Citizenship (code from ref.4)"

cgragref="Citizenship (value from ref.4)"

spd="Presence of the business entity’s registration (code from ref.5)"

spdref="Presence of the business entity’s registration (value from ref.5)"

sstate="Social status (code from ref.6)"

sstateref="Social status (value from ref.6)"

cchild="Number of children">

<!--This part can and must contain 1..* items-->

</ident>

<!-- History of the Information about Employer part -->

<work wdonor="Source of information (code from ref. 54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

cdolgn="Official position (code from ref.8)"

cdolgnref="Official position (value from ref.8)"

wokpo="EDRPOU of the employer"

wname="Name of the employer in the base language"

wstag="Length of service, years completed"

wdohod="Client’s monthly income">

<!--This part can contain 0..*-->

</work>

<!-- History of the Information about Documents part -->

<doc ddonor="Source of information (code from ref. 54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

dtype="Document type (code from ref.7)"

dtyperef="Document type (value from ref.7)"

dser="Document series"

dnom="Document number"

dterm="Expiration date"

dwho="Document issuer"

dwdt="Document issue date"

eddr_number="Unique record number in the Unified State Demographic Register">

<!--This part must contain 1..* units and at least one document-->

</doc>

<!-- History of the Information about Addresses part -->

<addr addonor="Source of information (code from ref. 54)"

vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

lngref="Part presentation language (value from ref.23)"

adtype="Address type (code from ref.9)"

adtyperef="Address type (value from ref.9)"

adcountry="Country (two-character code from ISO 3166 reference book)"

adindex="Postal code"

adstate="Region"

adarea="District"

adcity="Locality"

adcitytype="Locality type (code from ref.22)"

adcitytyperef="Locality type (value from ref.22)"

adstreet="Street"

adhome="House"

adcorp="Block"

adflat="Flat"

addrdirt="Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)">

<!--This part must contain 1..* units and at least one address-->

</addr>

</cki>

<!-- Block for converting documents for validity -->

<identdocmvds>

<identdocmvd found="Found? (Code from ref.27)"

foundref="Found? (Value from ref.27)"

foundtitle="Search result description"

pser="Series of the required passport"

pnom="Number of required passport or ID-card number"

dtype="Document type (Code from ref.7)"

dtyperef="Document type (Meaning from ref.7)">

<foundsource name="Data source for verification (Code from ref.63)"

found="0/1 - digital indication of the presence of an invalid passport (Code from ref.27)"

foundref="Text indication of the presence of an invalid passport (Value from ref.27)"

sourcedate="The date of updating the information in the database or receiving a response from the API of the original source" />

<!--This part must contain 1..* units and at least one document -->

</identdocmvd>

</identdocmvds>

</comp>

<!-- History of the Information about Contacts part -->

<comp id="10" descr="Names of components">

<cont inn="TIN of the credit history subject/EDRPOU of the legal entity"

cdonor="Source of information"

vdate="Date of the information from this part"

ctype="Contact type (code from ref.10)"

ctyperef="Contact type (value from ref.10)"

cval="Contact value">

<!--This part must contain 1..* units and at least one contact-->

</cont>

</comp>

<!-- Confirmation of the credit history subject’s contacts part -->

<comp id="46" descr="Names of components">

<contact cval="Contact value"

ctype="Contact type (code from ref.10)"

ctyperef="Contact type in text format (ref.10)"

cstate="Contact’s status (code from ref.57)"

cstateref="Contact’s status (text value from ref.57)"

vdatestart="First actualization date"

vdate="Last actualization date" />

<!--This part can contain 0..* items -->

</comp>

</ubkidata>

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-11-23 14:08:56.087" ftm="2022-08-23 14:08:56.316" />
    </trace>
    <reqinfo reqid="req2#000002458408" />
  </tech>
  <comp id="1" descr="Identification of the Credit History Subject (CHS)">
    <cki bdate="1957-10-19" reqlngref="Russian" reqlng="2" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724">
      <ident cchild="" sstateref="" sstate="" spdref="natural person" spd="1" cgragref="" cgrag="802" ceducref="" ceduc="" familyref="" family="" csexref="woman" csex="2" bdate="1957-10-19" mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" inn="2111118724" lngref="Russian" lng="2" vdate="2022-02-06" donor="BNK" />
      <work wdohod="" wstag="" wname="ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ 'УКРАЇНСЬКА КОМПАНІЯ 'О'" wokpo="34745377" cdolgnref="Worker/specialist/performer" cdolgn="3" lngref="Ukrainian" lng="1" vdate="2021-11-07" wdonor="BNK" />
      <doc dwdt="2004-03-10" dwho="ХЕРСОНСКИМ ГО УМВД" dterm="" dnom="142228" dser="ВВ" dtyperef="Passport" dtype="1" lngref="Ukrainian" lng="1" vdate="2021-08-01" eddr_number="19571019-00027" ddonor="BNK" />
      <addr adflat="81" adcorp="" adhome="11" adstreet="ВУЛ.ЕЖЕЛЕ" adcitytyperef="" adcitytype="" adcity="М.ХЕРСОН" adarea="" adstate="ХЕРСОНСЬКА" adindex="10000" adcountry="UA" adtyperef="Address of registration" adtype="2" lngref="Ukrainian" lng="1" vdate="1900-01-01" addonor="BNK" />
    </cki>
    <identdocmvds>
      <identdocmvd found="0" foundref="Not found" foundtitle="Passport ВВ-142228 not found in the list of cancelled." pser="ВВ" pnom="142228" dtype="1" dtyperef="Passport">
        <foundsource name="MVS" found="0" foundref="Not found" sourcedate="2022-10-16" />
        <foundsource name="DMS" found="0" foundref="Not found" sourcedate="2022-10-16" />
        <foundsource name="UBKI" found="0" foundref="Not found" sourcedate="2022-10-16" />
      </identdocmvd>
    </identdocmvds>
  </comp>
  <comp id="10" descr="Contacts">
    <cont cval="+380931656411" ctyperef="home phone" ctype="1" vdate="2022-02-13" cdonor="BNK" />
    <cont cval="+380662134234" ctyperef="mobile phone" ctype="3" vdate="2021-11-08" cdonor="BNK" />
    <cont cval="+380992254422" ctyperef="mobile phone" ctype="3" vdate="2021-08-14" cdonor="BNK" />
  </comp>
  <comp id="46" descr="Сontacts confirmation of the subject of the credit history">
    <contact cval="+380662134234" ctype="3" ctyperef="mobile phone" cstate="2" cstateref="Deactualization" vdatestart="2020-08-03" vdate="2020-10-08" />
    <contact cval="+380661111111" ctype="3" ctyperef="mobile phone" cstate="1" cstateref="Actualization" vdatestart="2020-05-12" vdate="2020-09-30" />
  </comp>
</ubkidata>

...