52 - Identification by phone and full name


Identification service by phone number and full name.

Http Method

POST

Request JSON
( ** the parameters are transferred optionally)

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"nameverif": {

"phone": "Contact value",

"lname": "Last name",

"fname": "First name",

"mname": "**Middle name"

},

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

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Identification by phone and full name' - 52",

"reqreason": "Purpose of the request (Code from the ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

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"

},

{

"pret": {

"pretension": {

"inn": "INN (for natural persons)/OKPO (for legal entities)",

"crdeal": "Transaction identifier (reference)",

"source": "Disputing type (Code from ref.48)",

"sourceref": "Disputing type (Value from ref.48)",

"claim" : "Subject of dispute (Code from ref. 69)",

                         "claimref": "Subject of dispute (Value from ref. 69)",

"vdate": "Date of the request creation"

},

"commentcki": {

"comment": "Commentary of the subject of credit history",

"vdate": "Date of a comment creation"

},

"plost": {

"pser": "Passport series claimed by the client as lost (theft)",

"pnom": "Passport number declared by the client as lost (theft)",

"crdate": "ДDate of creation of an application for the loss/theft of a client's passport in UBCH",

"ldate": "The date of loss / theft of the client's passport indicated in the application in UBCH"

},

"changedeal": {

"crdeal": "Transaction identifier (reference)",

"changecode": "Code for the reason of correction/deletion of data (Code from ref.62)",

"changeref": "Text of the reason for correcting/deleting data (Value from ref.62)",

"vdate": "Date of data correction/deletion"

},

"freezedate": "FREEZE option connection date",

"nonewdealcomment": "Comment",

"nonewdeal": "Sign of reluctance to draw up new loan products, connection status of the FREEZE option: 0 - not enabled, 1 - enabled",

"nonewdealref": "The value of the sign of unwillingness to draw up new credit products, the connection status of the FREEZE option is 0-no (the option is not connected), 1-yes (the option is connected)",

"inn": "INN (for natural persons)/OKPO (for legal entities)"

},

"fcert": {

"inn": "TIN",

"cert": "Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) ",

"certref": "Availability of a certificate from the UBCH (value from ref. 56)",

"certid": "Certificate number",

"certurl": "Link to the certificate"

},

"maybegone": {

"inn": "TIN",

"vdate": "Application creation date",

"dldonor": "Information provider (code from ref. 54)"

},

"id": "18",

"descr": "Components name"

},

{

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

},

{

"nameverif": {

"match": "The result of checking the phone number and full name (Code from ref.13)",

"matchref": "The result of checking the phone number and full name in text form (Value from ref.13)",

"numclients": "Indication of the presence of a match by phone number and full name in more than one client (0 - No, 1 - Yes)",

"numclientsref": "Indication of the presence of a match by phone number and name in more than one client (No/Yes)"

},

"id": "77",

"descr": "Names of components"

}

]

}

}

Request XML
( ** the parameters are transferred optionally

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

<doc>

<ubki sessid="Session key (we receive it from the API authorization)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request Parameters -->

<request version="1.0" reqtype="Template code (Code from the ref.49): 'Identification by phone and full name' - 52" reqreason="Purpose of the request (Code from the ref.24)">

<!-- Parameters, which describe the search criteria-->

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

<!-- Identification parameters of the subject-->

<nameverif phone="Contact value" 

                      lname="Last name"

fname="First name"

mname="**Middle name" />

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

<!-- Alert -->

<comp id="18" descr="Components name">

<pret nonewdeal="Sign of reluctance to draw up new loan products, connection status of the FREEZE option: 0 - not enabled, 1 - enabled"

nonewdealref="The value of the sign of unwillingness to draw up new credit products, the connection status of the FREEZE option is 0-no (the option is not connected), 1-yes (the option is connected)"

freezedate="FREEZE option connection date"

nonewdealcomment="Comment"

inn="INN (for natural persons)/OKPO (for legal entities)">

<pretension inn="INN (for natural persons)/OKPO (for legal entities)"

crdeal="Transaction identifier (reference)"

source="Disputing type (Code from ref.48)"

sourceref="Disputing type (Value from ref.48)"

claim="Subject of dispute (Code from ref. 69)"

                         claimref="Subject of dispute (Value from ref. 69)"

vdate="Date of the request creation" />

<commentcki comment="Commentary of the subject of credit history"

vdate="Date of a comment creation" />

<plost pser="Passport series claimed by the client as lost (theft)"

pnom="Passport number declared by the client as lost (theft)"

crdate="ДDate of creation of an application for the loss/theft of a client's passport in UBCH"

ldate="The date of loss / theft of the client's passport indicated in the application in UBCH" />

<changedeal crdeal="Transaction identifier (reference)"

changecode="Code for the reason of correction/deletion of data (Code from ref.62)"

changeref="Text of the reason for correcting/deleting data (Value from ref.62)"

vdate="Date of data correction/deletion" />

</pret>

<fcert inn="TIN"

cert="Availability of a certificate from the UBCH (code from ref. 56) - 0 - no (no registered certificate), 1 - yes (registered certificate) "

certref="Availability of a certificate from the UBCH (value from ref. 56)"

certid="Certificate number"

certurl="Link to the certificate" />

<maybegone inn="TIN"

vdate="Application creation date"

dldonor="Information provider (code from ref. 54)"/>

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

<!-- Identification by phone and full name -->

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

<nameverif match="The result of checking the phone number and full name (Code from ref.13)"

                      matchref="The result of checking the phone number and full name in text form (Value from ref.13)"

                      numclients = "Indication of the presence of a match by phone number and full name in more than one client (0 - No, 1 - Yes)"

                      numclientsref = "Indication of the presence of a match by phone number and name in more than one client (No/Yes)"/>

</comp>

</ubkidata>

Приклад

Приклад

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "nameverif": { "phone": "+380962134234", "mname": "VASYLIVNA", "fname": "IRINA", "lname": "HARNA" }, "reqlng": "4" }, "version": "1.0", "reqtype": "52", "reqreason": "2" } } }, "sessid": "7AC5104A93364D8FB7A9DBF50C963CE3" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-11-07 14:27:05.229", "ftm": "2022-10-07 14:27:05.715" } }, "reqinfo": { "reqid": "req2#000002481742" } }, "comp": [ { "cki": { "ident": [ { "cchild": "", "sstateref": "", "sstate": "", "spdref": "natural person", "spd": "1", "cgragref": "Ukraine", "cgrag": "804", "ceducref": "", "ceduc": "", "familyref": "", "family": "", "csexref": "woman", "csex": "2", "bdate": "1989-10-05", "mname": "ВАСИЛІВНА", "fname": "ІРІНА", "lname": "ГАРНА", "inn": "3278508288", "lngref": "Ukrainian", "lng": "1", "vdate": "2022-04-25", "donor": "BNK" }, { "cchild": "", "sstateref": "", "sstate": "", "spdref": "natural person", "spd": "1", "cgragref": "", "cgrag": "804", "ceducref": "", "ceduc": "", "familyref": "", "family": "", "csexref": "woman", "csex": "2", "bdate": "1989-10-05", "mname": "ВАСИЛІВНА", "fname": "ІРИНА", "lname": "ГАРНА", "inn": "3278508288", "lngref": "Ukrainian", "lng": "1", "vdate": "2007-10-04", "donor": "BNK" } ], "doc": { "dwdt": "2002-08-01", "dwho": "ІВАНГОРОДСЬКИМ", "dterm": "", "dnom": "578072", "dser": "АМ", "dtyperef": "Ukrainian citizen passport", "dtype": "1", "lngref": "Ukrainian", "lng": "1", "vdate": "2022-04-10", "eddr_number": "19891005-00022", "ddonor": "BNK" }, "addr": { "adflat": "", "adcorp": "", "adhome": "7", "adstreet": "ТИХА", "adcitytyperef": "", "adcitytype": "", "adcity": "JВDКВJ", "adarea": "ІВАНГОРОДСКИЙ", "adstate": "ДНЕПРОПЕТРОВСКАЯ", "adindex": "23201", "adcountry": "UA", "adtyperef": "Address of registration", "adtype": "2", "lngref": "Ukrainian", "lng": "1", "vdate": "2022-04-25", "addonor": "BNK" }, "bdate": "1989-10-05", "reqlngref": "Ukrainian", "reqlng": "1", "mname": "ВАСИЛІВНА", "fname": "ІРІНА", "lname": "ГАРНА", "inn": "3278508288" }, "identdocmvds": { "identdocmvd": { "foundsource": [ { "name": "MVS", "found": "1", "foundref": "Found", "sourcedate": "2022-10-16" }, { "name": "DMS", "found": "0", "foundref": "Not found", "sourcedate": "2022-10-16" }, { "name": "UBKI", "found": "0", "foundref": "Not found", "sourcedate": "2022-10-16" } ], "found": "1", "foundref": "Found", "foundtitle": "Passport АМ-578072 is found in the list of invalid passports", "pser": "АМ", "pnom": "578072", "dtype": "1", "dtyperef": "Ukrainian citizen passport" } }, "id": "1", "descr": "Identification of the Credit History Subject (CHS)" }, { "pret": { "inn": "3278508288", "nonewdeal": "0", "nonewdealref": "No", "nonewdealcomment": "", "freezedate": "" }, "fcert": { "inn": "3278508288", "cert": "0", "certref": "No", "certid": "", "certurl": "" }, "maybegone": { "inn": "3278508288", "vdate": "2022-12-01", "dldonor": "BNK" }, "id": "18", "descr": "Alert" }, { "contact": [ { "cval": "JOHNDOE@GMAIL.COM", "ctype": "4", "ctyperef": "email", "cstate": "2", "cstateref": "Deactualization", "vdatestart": "2024-05-07", "vdate": "2024-05-09" }, { "cval": "+380662134234", "ctype": "3", "ctyperef": "mobile phone", "cstate": "1", "cstateref": "Actualization", "vdatestart": "2020-09-03", "vdate": "2020-09-08" }, { "cval": "+380111111111", "ctype": "3", "ctyperef": "mobile phone", "cstate": "2", "cstateref": "Deactualization", "vdatestart": "2020-06-12", "vdate": "2020-08-30" } ], "id": "46", "descr": "Сontacts confirmation of the subject of the credit history" }, { "nameverif": { "match": "1", "matchref": "Yes", "numclients": "0", "numclientsref": "No" }, "id": "77", "descr": "Identification by phone and full name" } ] } }

Request XML

<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D"> <req_envelope> <req_xml> <request version="1.0" reqtype="52" reqreason="2"> <i reqlng="1"> <nameverif phone="+380962134234" mname="VASYLIVNA" fname="IRINA" lname="HARNA" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML

Test URL

Test data

  • mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" cval="+380981220000"

  • mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" cval="+380935171868"

  • mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" cval="+380506630641"

  • mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" cval="+380971321122"

  • mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" cval="+380732144444"

  • mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" cval="+380981224895"

  • mname="ІГОРЕВНА" fname="АННА" lname="РИБАЧКА" cval="+380662134234"

  • mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" cval="+380962134234"

 

<comp id="18" descr="Alert">, option Freeze

lname="Ivanov" fname="Ivan" mname="Ivanovitch" cval="380671234567"

 

<comp id="18"descr="Alert"> tag <changedeal>

  • mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" cval="+380981220000"