Versions Compared

Old Version 5

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version Current

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

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

...

Http Method

POST

Request URL

https://secure.ubki.ua/b2_api_xml/ubki/xml

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

"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): ‘FICO score’ – 46",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

Response JSON

Expand
titlebody:

{

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

}

}

},

"compbilldetails": {

"scoreficofreemon": { "UniqueID": "Unique identifying number/ID"Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"Scorefreemonref": "The FICO® Score itself (300 to 850 or 0 for not scored due to lack of data)", "ReasonCode1": "Highest Reason code (Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"comp": {

"scorefico": {

"UniqueID": "Unique identifying number/ID",

"Score": "The FICO® Score itself (300 to 850 or 0 for not scored due to lack of data)",

"ReasonCode1": "Highest Reason code (Code from ref.70)",

"ReasonCode2": "2nd Highest Reason (Code from ref.70)",

"ReasonCode3": "3rd Highest Reason (Code from ref.70)",

"ReasonCode4": "4th Highest Reason (Code from ref.70)"

},

"id": "69",

"descr": "Components name"

}

}

}

...

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

<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="69" descr="Names of components">

<scorefico UniqueID="Unique identifying number/ID"

Score="The FICO® Score itself (300 to 850 or 0 for not scored due to lack of data)"

ReasonCode1="Highest Reason code (Code from ref.70)"

ReasonCode2="2nd Highest Reason (Code from ref.70)"

ReasonCode3="3rd Highest Reason (Code from ref.70)"

ReasonCode4="4th Highest Reason (Code from ref.70)" >

</scorefico>

</comp>

</ubkidata>

...