Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

FICO® Score, the independent standard in credit risk scoring, empowers lender decisions to extend loans.

The report contains the following components:

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)

  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

 body:

{

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

}

}

},

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

}

}

}

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

  body:

<?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): 'FICO score' – 46" 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)"

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

 body:

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

Example

Request JSON

{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"bdate": "1989-10-05",
								"mname": "ВАСИЛІВНА",
								"fname": "ІРІНА",
								"lname": "ГАРНА",
								"okpo": "3278508288"
							},
							"docs": {
								"doc": {
									"dtype": "1",
									"dser": "АМ",
									"dnom": "578072"
								}
							},
							"contacts": {
								"cont": {
									"cval": "+380962134234",
									"ctype": "3"
								}
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "46",
						"reqreason": "2"
					}
				}
			},
			"sessid": "6D7D781B1E884A6AB384481804A35EA8"
		}
	}
}

Response JSON

{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2022-11-09 19:08:22.647",
					"ftm": "2022-01-09 19:08:22.734"
				}
			},
			"reqinfo": {
				"reqid": "req2#000002007797"
			}
		},
		"comp": {
			"scorefico": [
				{
					UniqueID: "2a147ebbb2b9281fcad5e232c9003e5f9116e0f1175caebd426cb8d1b65145e3",
                    Score: "550",
                    ReasonCode1: "D8",
                    ReasonCode2: "D2",
                    ReasonCode3: "M1",
                    ReasonCode4: "E0"
				}
			],
			"id": "69",
			"descr": "FICO score"
		}
	}
}

Request XML

<?xml version="1.0" encoding="UTF-8"?>
<doc>
   <ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
      <req_envelope>
         <req_xml descr>
            <request version="1.0" reqtype="46" reqreason="2">
               <i reqlng="1">
                  <ident bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" />
                  <docs>
                     <doc dtype="1" dser="АМ" dnom="578072" />
                  </docs>
                  <contacts>
                     <cont cval="+380962134234" ctype="3" />
                  </contacts>
               </i>
            </request>
         </req_xml>
      </req_envelope>
   </ubki>
</doc>

Response XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
    <tech>
        <trace>
            <step name="build report" stm="2023-09-20 11:42:31.427" ftm="2023-09-20 11:42:31.464"/>
        </trace>
        <reqinfo reqid="req2#000002911801"/>
    </tech>
    <comp id="69" descr="FICO score">
        <scorefico UniqueID="2a147ebbb2b9281fcad5e232c9003e5f9116e0f1175caebd426cb8d1b65145e3" Score="550" ReasonCode1="D8" ReasonCode2="D2" ReasonCode3="M1" ReasonCode4="E0" />
   </comp>
</ubkidata>

XSD Schema request

https://secure.ubki.ua/b2/js/xsd/request46.xsd

XSD Schema response

https://secure.ubki.ua/b2/js/xsd/response46.xsd

Test URL

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

Test data

  • No labels