Versions Compared

Key

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

...

Request JSON

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"afsubki": {

"request": [

{

"mode": "Request type (full, short)",

"dlrolesub": "Subject’s role (code from ref.14). Clarification: Value 3 from the reference book is not used for AFS UBKI",

"inn": "Client’s TIN (for individuals)",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"mphone": "Mobile phone",

"wphone": "Business phone 1",

"wphone2": "Business Phone 2",

"wphone3": "Business phone 3",

"livphone": "Phone number at the place of residence",

"apnum": "Application No.",

"apdate": "Application date and time"

},

{

"mode": "Request type (full, short)",

"dlrolesub": "Subject’s role (code from ref.14). Clarification: Value 3 from the reference book is not used for AFS UBKI",

"inn": "Client’s TIN (for individuals)",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"dser": "Passport series",

"dnom": "Passport number",

"innsp": "Spouse’s TIN",

"inncp": "Identification number of the contact person in the application",

"wname": "Name of the principal employer",

"wokpo": "EDRPOU of the principal employer",

"ureconom": "Industrial sector of the principal employer’s company (code from ref.36)",

"wstaff": "Number of employees of the principal employer",

"wcountry": "Country where the principal employer is located",

"wstate": "Region where the principal employer is located",

"wcity": "City/town where the principal employer is located",

"wstreet": "Street where the principal employer is located",

"whome": "House where the principal employer is located",

"wflat": "Office where the principal employer is located",

"windex": "Index of the principal employer",

"wothername": "Name of the additional employer",

"wotherokpo": "EDRPOU of the additional employer",

"ureconomother": "Industrial sector of the additional employer’s company (code from ref.36)",

"wotherstaff": "Number of employees of the additional employer’s organization",

"wothercountry": "Country where the additional employer is located",

"wotherstate": "Region where the additional employer is located",

"wothercity": "City/town where the additional employer is located",

"wotherstreet": "Street where the additional employer is located",

"wotherhome": "House where the additional employer is located",

"wotherflat": "Office where the additional employer is located",

"wotherindex": "Index of the additional employer’s location",

"mphone": "Mobile phone",

"wphone": "Business phone 1",

"wphone2": "Business Phone 2",

"wphone3": "Business phone 3",

"regphone": "Phone number at the place of registration",

"livphone": "Phone number at the place of residence",

"contphone": "Phone number of the contact person 1",

"contphone2": "Phone number of the contact person 2",

"regindex": "Index at the place of registration",

"regstate": "Region at the place of registration",

"regcity": "Registration city",

"regstreet": "Street name",

"reghome": "House number",

"regflat": "Flat number",

"adindex": "Index at the place of residence",

"adstate": "Region at the place of residence",

"adcity": "City/town of residence",

"adstreet": "Street name",

"adhome": "House number",

"adflat": "Flat number",

"apnum": "Application No.",

"apdate": "Date",

"dlcelcred": "Transaction type (code from ref.17). Clarification: For AFS UBKI the following values are used: '5', '6', '7', '8', '31'",

"dlchanel": "Application’s sales channel. (Code from ref.44)",

"dlaask": "Credit amount requested in UAH.",

"dlamt": "Amount issued in UAH.",

"wofdohod": "Monthly income (official) specified by the applicant in UAH.",

"waddohod": "Monthly income (additional) specified by the applicant in UAH.",

"appregion": "Region where the application is submitted (code from ref.34). Clarification: Values in the reference book starting from 28 are not used for AFS UBKI",

"appdepart": "Name of the department where the application is submitted",

"appcredman": "Credit expert",

"wtotstag": "General length of service (months)",

"wcurstag": "Current length of service (months)",

"foto": "base64(Photo)"

}

],

"update": {

"uid": "ID if the application obtained upon the first request",

"inn": "Client’s identification number (for individuals)",

"personfs": "Risk status of the client (code from ref.43)",

"passportfs": "Risk status of the passport (code from ref.43)",

"spousefs": "Risk status of the spouse (code from ref.43)",

"cpfs": "Risk status of the credit line (Code from the ref.43)",

"wfs": "Risk status of the principal employer. (Code from the ref.43)",

"waddfs": "Risk status of the principal employer’s address. (Code from the ref.43)",

"wotherfs": "Risk status of the additional employer. (Code from the ref.43)",

"wotheraddfs": "Risk status of the additional employer’s address. (Code from the ref.43)",

"mphonefs": "Risk status of the mobile phone. (Code from the ref.43)",

"wphonefs": "Risk status of the business phone. (Code from the ref.43)",

"wphone2fs": "Risk status of the business phone 2. (Code from the ref.43)",

"wphone3fs": "Risk status of the business phone 3. (Code from the ref.43)",

"regphonefs": "Risk status of the phone at the place of registration. (Code from the ref.43)",

"livphonefs": "Risk status of the phone at the place of residence. (Code from the ref.43)",

"contphonefs": "Risk status of the contact person 1. (Code from the ref.43)",

"contphone2fs": "Risk status of the contact person 2 (code from ref.43)",

"regfs": "Risk status of the address at the place of registration. (Code from the ref.43)",

"adfs": "Risk status of the address at the place of residence. (Code from the ref.43)",

"apstatus": "Loan application status. (Code from ref.45)",

"apdecisdate": "Date",

"appfs": "Risk status of the application. (Code from the ref.43)",

"dlamt": "Amount issued in UAH."

}

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): 'UBCH Anti-Fraud System ' – 16",

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

},

"descr": "Request object"

},

"descr": "Request envelope"

},

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

}

}

}

...

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step": {
					"name": "build report",
					"stm": "2019-01-17 10:31:34.889",
					"ftm": "2019-01-17 10:31:35.781"
				}
			},
			"reqinfo": {
				"reqid": "req2#000000562528"
			}
		},
		"comp": [
			{
				"afsubki": {
					"resprequest": {
						"consolidated": [
							{
								"name": "CR1",
								"inn": "0123443211",
								"countappday": "0",
								"countappdayownno": "0",
								"countappweek": "0",
								"countappweekownno": "0"
							},
							{
								"name": "CR2",
								"livphone": "",
								"countclient": "0",
								"countclientownno": "0",
								"countclientdecl": "0",
								"countclientdeclownno": "0",
								"proportionclientdecl": "",
								"proportionclientdeclownno": ""
							},
							{
								"name": "CR3",
								"mphone": "+380990000009",
								"countclient": "0",
								"countclientownno": "0",
								"countclientdecl": "0",
								"countclientdeclownno": "0",
								"proportionclientdecl": "",
								"proportionclientdeclownno": ""
							},
							{
								"name": "CR4",
								"countapp": "0",
								"countappownno": "0",
								"wphone": "",
								"wphone2": "",
								"wphone3": ""
							},
							{
								"name": "CR5",
								"inn": "0123443211",
								"countappdenied": "0",
								"countappdeniedownno": "0"
							}
						],
						"uid": "416250b6-bcdf-4692-ac19-13736ac50f7d"
					},
					"inn": "0123443211"
				},
				"id": "15",
				"descr": "AFS УБКІ"
			},
			{
				"pret": {
					"inn": "0123443211",
					"nonewdeal": "0",
					"nonewdealref": "No",
					"nonewdealcomment": "",
					"freezedate":""
				},
				"fcert": {
					"inn": "32785082880123443211",
					"cert": "0",
					"certref": "No",
					"certid": "",
					"certurl": ""
				},
				"maybegone": {
					"inn": "3278508288",
					"vdate": "2022-12-01",
					"dldonor": "BNK"
				},
				"id": "18",
				"descr": "Alert"
			}
		]
	}
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2019-01-17 10:31:34.889" ftm="2019-01-17 10:31:35.781" />
    </trace>
    <reqinfo reqid="req2#000000562528" />
  </tech>
  <comp id="15" descr="AFS УБКІ">
    <afsubki inn="0123443211">
      <resprequest uid="416250b6-bcdf-4692-ac19-13736ac50f7d">
        <consolidated name="CR1" inn="0123443211" countappday="0" countappdayownno="0" countappweek="0" countappweekownno="0" />
        <consolidated name="CR2" livphone="" countclient="0" countclientownno="0" countclientdecl="0" countclientdeclownno="0" proportionclientdecl="" proportionclientdeclownno="" />
        <consolidated name="CR3" mphone="+380990000009" countclient="0" countclientownno="0" countclientdecl="0" countclientdeclownno="0" proportionclientdecl="" proportionclientdeclownno="" />
        <consolidated name="CR4" countapp="0" countappownno="0" wphone="" wphone2="" wphone3="" />
        <consolidated name="CR5" inn="0123443211" countappdenied="0" countappdeniedownno="0" />
      </resprequest>
    </afsubki>
  </comp>
  <comp id="18" descr="Alert">
    <pret inn="0123443211" nonewdeal="0" nonewdealref="No" nonewdealcomment="" freezedate="" />
    <fcert inn="32785082880123443211" cert="0" certref="No" certid="" certurl="" />
    <maybegone inn="3278508288" vdate="2022-12-01" dldonor="BNK" />
  </comp>
</ubkidata>

...