The report contains the following components: |
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON/Checking if the combination of the phone and date of birth is correct |
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "phoneverif": { "phone": "Mobile phone", "bdate": "Date of birth", "**channelotp": "sms" }, "reqlng": "Search criteria language (code from ref.23)" }, "version": "1.0", "reqtype": "Template code (code from ref.49): 'Identification by phone number and date of birth' report – 34", "reqreason": "Request objective (code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (obtained from the authorization API)" } } } |
Response JSON
|
Request XML/Checking if the combination of the phone and date of birth is correct |
<?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): 'Identification by phone number and date of birth' report – 34" reqreason="Request objective (code from ref.24)"> <!-- Parameters describing search criteria--> <i reqlng="Search criteria language (code from ref.23)"> <!-- Subject identification parameters--> <phoneverif phone="Mobile phone" bdate="Date of birth" **channelotp="sms" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Request JSON/Obtaining client details upon OTP verification |
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "phoneverif": { "phone": "Mobile phone", "bdate": "Date of birth", "reqid": "Outgoing request ID generated by UBKI", "**otp": "SMS code" }, "reqlng": "Search criteria language (code from ref.23)" }, "version": "1.0", "reqtype": "Template code (code from ref.49): 'Identification of a credit history subject by phone number and date of birth' report – 34", "reqreason": "Request objective (code from ref.24)" }, "descr": "Request object" }, "descr": "Request envelope" }, "sessid": "Session key (obtained from the authorization API)" } } } |
Response JSON
|
Request XML/Obtaining client details upon OTP verification |
<?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): 'Identification of a credit history subject by phone number and date of birth' report – 34" reqreason="Request objective (code from ref.24)"> <!-- Parameters describing search criteria--> <i reqlng="Search criteria language (code from ref.23)"> <!-- Subject identification parameters--> <phoneverif phone="Mobile phone" bdate="Date of birth" reqid="Outgoing request ID generated by UBKI" **otp="SMS code" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Example (Checking the correct pairing of phone and date of birth) |
---|
Request JSON |
|
Response JSON |
|
Request XML |
|
Response XML |
|
Example (Receiving client data after OTP verification) |
---|
Request JSON |
|
Response JSON |
|
Request XML |
|
Response XML |
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request34.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response34.xsd |
Test URL | https://test.ubki.ua/b2_api_xml/ubki/xml |
---|---|
Test data |
|