04 - Contacts


Information about contacts of the individual and history of their changes.


Http Method

POST

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

{

"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 JSON

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Step name",

"stm": "Step start stamp date",

"ftm": "Step finish stamp date"

}

},

"error": {

"errtype": "Error code (code from ref.0)",

"errtext": "Error text (value from ref.0)"

},

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI"

},

"billing": {

"balance": {

"value": "Total assets",

"date": "Date",

"time": "Time"

},

"billdetails": {

"freemon": "Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"freemonref": "Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"comp": [

{

"cki": {

"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"

},

"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"

},

"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"

},

"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)"

},

"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"

},

"identdocmvds": {

"identdocmvd": {

"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"

},

"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)"

}

},

"id": "1",

"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"

},

"id": "10",

"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"

},

"id": "46",

"descr": "Names of components"

}

]

}

}

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

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

<doc>

<ubki sessid="Session key (obtained from the authorization API)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request parameters -->

<request version="1.0" reqtype="Template code (code from ref.49): 'Contacts' report – 04" reqreason="Request objective (code from ref.24)">

<!-- Parameters describing search criteria-->

<i reqlng="Search criteria language (code from ref.23)">

<!-- Subject identification parameters-->

<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">

</ident>

<contacts>

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

cval="**Contact value" />

</contacts>

<docs>

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

dser="**Document series"

dnom="**Document number" />

</docs>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

<?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" />

<billdetails freemon="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)"

freemonref="Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"/>

</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>

Example

Example

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "bdate": "1957-10-19", "mname": "Igorevna", "fname": "ANNA", "lname": "RYBACHKA", "okpo": "2111118724" }, "docs": { "doc": { "dtype": "1", "dser": "ВВ", "dnom": "142228" } }, "contacts": { "cont": { "cval": "+380662134234", "ctype": "3" } }, "reqlng": "4" }, "version": "1.0", "reqtype": "04", "reqreason": "2" } } }, "sessid": "A299920488F44175B64ED733AC999D96" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-11-23 14:08:56.087", "ftm": "2022-08-23 14:08:56.316" } }, "reqinfo": { "reqid": "req2#000002458408" } }, "comp": [ { "cki": { "ident": { "cchild": "", "sstateref": "", "sstate": "", "spdref": "natural person", "spd": "1", "cgragref": "", "cgrag": "804", "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": "Ukrainian citizen 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": "",