Request parameters

version

Xml request version

[TEXT,10] variable length text format, up to 10 characters

reqtype*

Template code (ref. 49)

[TEXT,10] variable length text format, up to 10 characters

reqsubtype*

Sub-template code for 07 - Visa Transaction Underwriting Score Report (1 - receiving scoring and attributes; 2 - receiving attributes; not filled in in case of receiving only scoring)

[TEXT,10] variable length text format, up to 10 characters

reqreason*

Request objective (ref. 24)

[N,10], numeric format

reqdate

Request date and time (decommissioned 19.05.2022)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

reqidout

Request ID from the partner’s side (decommissioned 19.05.2022)

[TEXT,50] variable length text format, up to 50 characters

reqsource

Requester (decommissioned 19.05.2022)

[N,10], numeric format

<i> (1) Attributes describing search criteria

reqlng

Search criteria language (ref. 23)

[N,10], numeric format

<ident> (1) Attributes for subject identification

okpo*

Tax/Taxpayer Identification Number (TIN-RNUKPN, for individuals)/EDRPOU (for legal entities)

[N,10], numeric format

lname*

Last name

[TEXT,40] variable length text format, up to 40 characters

fname*

First name

[TEXT,40] variable length text format, up to 40 characters

mname*

Middle name

[TEXT,40] variable length text format, up to 40 characters

bdate*

Date of birth

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

</ident>

<docs> (0..*) Documents

<doc>

dtype*

Document type (ref. 7)

[N,10], numeric format

dser*

Document series

[TEXT,10] variable length text format, up to 10 characters

dnom*

Document number

[TEXT,9] variable length text format, up to 9 characters

</docs>

<contacts> (0..*) Contacts

<cont>

ctype*

Contact type (ref. 10)

[N,10], numeric format

cval*

Contact value

[TEXT,40] variable length text format, up to 40 characters

</contacts>

<mvd> (1) Checking according to the databases of the invalid documents

dtype*

Sought-for document type. Available values – 1,3, 5, 17 (ref. 7). If dtype is not completed, the default value is 1 (backward compatibility)

[N,10], numeric format

pser*

Sought-for passport series or blank attribute if ID card

[TEXT,10] variable length text format, up to 10 characters

pnom*

Number of the sought-for passport or ID card

[TEXT,9] variable length text format, up to 9 characters

plname

Last name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine

[TEXT,40] variable length text format, up to 40 characters

pfname

First name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine

[TEXT,40] variable length text format, up to 40 characters

pmname

Middle name for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine

[TEXT,40] variable length text format, up to 40 characters

pbdate

Date of birth for searching in the database of wanted persons in the Ministry of Internal Affairs of Ukraine

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

</mvd>

<fotoverif> (1) Attributes for photo verification

freqtype*

Request type:

1 – in the in-house photo-database,

2 – in photo-databases of other banks,

3 – comparison of two persons on the photo (for example, face in the passport and face of the person holding it),

4 – reserved,

5 – in the photo-database of compromised persons,

6 – comparison with the photo from the document

[N,1] 1 numeric characters

inn*

Tax/Taxpayer Identification Number (TIN-RNUKPN)

[N,10] 10 numeric characters

facelogic

Type of face search algorithm:

1 – search for a face occupying the largest space

2 – search for a face in the center of the photo

3 – search of a sought-for face among all the faces, the first face selected to work is located closest to the center, others – in any order. If the similarity measure of the first face exceeds the threshold, the search is stopped.

If facelogic parameter is missing, facelogic = 3 logic is applied

[N,1] 1 numeric characters

foto*

Base64(Photo) of the incoming application (LHS)

[TEXT,~] variable length text format

fotoext*

Extension of the incoming application’s photo

[TEXT,10] variable length text format, up to 10 characters

phone

Phone number for comparison

[TEXT,50] variable length text format, up to 50 characters

</fotoverif>

<spd> (1) Attributes for a business entity’s report

inn

Tax Identification Number (TIN, for individuals)/EDRPOU (for legal entities)

[N,10] 10 numeric characters

</spd>

<telecom> (1) Attributes for the Telecom Report

phone

Phone number for comparison

[TEXT,50] variable length text format, up to 50 characters

datecut

Calculation date. If the date ="" – calculated for today, otherwise – for the beginning of the day specified

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

</telecom>

<drorm> (1) Attributes for the "Information from the DRORM" report

value

Number of the enforcement proceedings

[N,10], numeric format

</drorm>

<rrp> (1) Attributes for the "Information from Property Rights Register" report

value

Encumbrance number by subject

[TEXT,25] variable length text format, up to 25 characters

</rrp>

<additionaldata> (1) Attributes for the reports "Court decision" and "Mass media reports"

courtid

Court document number

[N,10], numeric format

smiid

News ID in the Bureau’s database

[TEXT,40] textual

</additionaldata>

<phoneverif> Identification of a credit history subject by a phone number and date of birth for self-service terminals

phone

Phone number

[TEXT,50] variable length text format, up to 50 characters

bdate

Date of birth

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

reqid

Outgoing request ID generated by UBKI

[TEXT,40] textual

channelotp

Sending channel otp

[TEXT, 3] variable length text format, up to 3 characters

otp

Code from sms

[N, 10] 10 numeric characters

</phoneverif>

<afsubki> (1) AFS (Anti Fraud System) UBKI

inn

Tax Identification Number (TIN, for individuals)/EDRPOU (for legal entities)

[N,10] 10 numeric characters

<request> (1) First request

mode

Request type ("full" or "short"), "full" if not specified

[TEXT,10] variable length text format, up to 10 characters

dlrolesub*

Subject’s role (ref. 14). Clarification: value "3" of the reference book for AFS UBKI is not used)

[N,10] 10 numeric characters

inn*

Client’s identification number (for individuals)

[N,10] 10 numeric characters

lname*

Last name

[TEXT,50] variable length text format, up to 50 characters

fname*

First name

[TEXT,50] variable length text format, up to 50 characters

mname

Middle name

[TEXT,50] variable length text format, up to 50 characters

bdate*

Date of birth

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

dser*

Passport series

[TEXT,10] variable length text format, up to 10 characters

dnom*

Passport number

[TEXT,9] variable length text format, up to 9 characters

innsp

Spouse’s TIN

[N,10] 10 numeric characters

inncp

Identification number of the contact person in the application

[N,10] 10 numeric characters

wname*

Name of the principal employer (if none, units are transmitted)

[N,10] 10 numeric characters

wokpo*

EDRPOU of the principal employer

[N,10] 10 numeric characters

ureconom

Industrial sector of the principal employer’s company (ref. 36)

[TEXT,100] variable length text format, up to 100 characters

wstaff

Number of employees of the principal employer

[N,10] 10 numeric characters

wcountry

Country where the principal employer is located

[TEXT,40] variable length text format, up to 40 characters

wstate

Region where the principal employer is located

[TEXT,40] variable length text format, up to 40 characters

wcity

City/town where the principal employer is located

[TEXT,40] variable length text format, up to 40 characters

wstreet

Street where the principal employer is located

[TEXT,100] variable length text format, up to 100 characters

whome

House where the principal employer is located

[TEXT,40] variable length text format, up to 40 characters

wflat

Office where the principal employer is located

[TEXT,40] variable length text format, up to 40 characters

windex

Index of the principal employer

[N,5] 5 numeric characters

wothername

Name of the additional employer

[TEXT,250] variable length text format, up to 250 characters

wotherokpo

EDRPOU of the additional employer

[N,10] 10 numeric characters

ureconomother

Industrial sector of the additional employer’s company

[TEXT,100] variable length text format, up to 100 characters

wotherstaff

Number of employees of the additional employer’s organization

[N,10] 10 numeric characters

wothercountry

Country where the additional employer is located

[TEXT,40] variable length text format, up to 40 characters

wotherstate

Region where the additional employer is located

[TEXT,40] variable length text format, up to 40 characters

wothercity

City/town where the additional employer is located

[TEXT,100] variable length text format, up to 40 characters

wotherstreet

Street where the additional employer is located

[TEXT,40] variable length text format, up to 40 characters

wotherhome

House where the additional employer is located

[TEXT,40] variable length text format, up to 40 characters

wotherflat

Office where the additional employer is located

[TEXT,40] variable length text format, up to 40 characters

wotherindex

Index of the additional employer’s location

[N,5] 5 numeric characters

mphone*

Mobile phone

[TEXT,40] variable length text format, up to 40 characters

wphone

Business phone 1

[TEXT,40] variable length text format, up to 40 characters

wphone2

Business phone 2

[TEXT,40] variable length text format, up to 40 characters

wphone3

Business phone 3

[TEXT,40] variable length text format, up to 40 characters

regphone

Phone number at the place of registration

[TEXT,40] variable length text format, up to 40 characters

livphone

Phone number at the place of residence

[TEXT,40] variable length text format, up to 40 characters

contphone

Phone number of the contact person 1

[TEXT,40] variable length text format, up to 40 characters

contphone2

Phone number of the contact person 2

[TEXT,40] variable length text format, up to 40 characters

regindex

Index at the place of registration

[N,5] 5 numeric characters

regstate

Region at the place of registration

[TEXT,40] variable length text format, up to 40 characters

regcity

Registration city

[TEXT,40] variable length text format, up to 40 characters

regstreet

Street name

[TEXT,100] variable length text format, up to 100 characters

reghome

House number

[TEXT,40] variable length text format, up to 40 characters

regflat

Flat number

[TEXT,40] variable length text format, up to 40 characters

adindex

Index at the place of residence

[N,5] 5 numeric characters

adstate

Region at the place of residence

[TEXT,40] variable length text format, up to 40 characters

adcity

City/town of residence

[TEXT,40] variable length text format, up to 40 characters

adstreet

Street name

[TEXT,100] variable length text format, up to 100 characters

adhome

House number

[TEXT,40] variable length text format, up to 40 characters

adflat

Flat number

[TEXT,40] variable length text format, up to 40 characters

apnum

Application No.

[TEXT,20] variable length text format, up to 20 characters

apdate

Date and time

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

dlcelcred*

Transaction type (ref. 17). Clarification: for AFS UBKI the following values are used: "5", "6", "7", "8", "31")

[N,10], numeric format

dlchanel

Application’s sales channel (ref. 44)

[N,10], numeric format

dlaask*

Credit amount requested in UAH

[N,15,2], numeric format with a floating point, 2 digits after the point

dlamt*

Amount issued in UAH

[N,15,2], numeric format with a floating point, 2 digits after the point

wofdohod*

Monthly income (official) specified by the applicant in UAH

[N,15,2], numeric format with a floating point, 2 digits after the point

waddohod

Monthly income (additional) specified by the applicant in UAH

[N,15,2], numeric format with a floating point, 2 digits after the point

appregion*

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

[N,10], numeric format

appdepart*

Name of the department where the application is submitted

[TEXT,50] variable length text format, up to 50 characters

appcredman

Credit expert

[TEXT,50] variable length text format, up to 50 characters

wtotstag*

General length of service (months)

[N,10], numeric format

wcurstag*

Current length of service (months)

[TEXT,50] variable length text format, up to 50 characters

foto

base64(Photo)

[TEXT,~] variable length text format

</request>

<update> (1) Updating the application data

uid*

ID if the application obtained upon the first request

[TEXT,50] variable length text format, up to 50 characters

inn*

Client’s identification number (for individuals)

[N,10], numeric format

personfs

Risk status of the client (ref. 43)

[N,10], numeric format

passportfs

Risk status of the passport (ref. 43)

[N,10], numeric format

spousefs

Risk status of the spouse (ref. 43)

[N,10], numeric format

cpfs

Risk status of the credit line (ref. 43)

[N,10], numeric format

wfs

Risk status of the principal employer (ref. 43)

[N,10], numeric format

waddfs

Risk status of the principal employer’s address. (ref. 43)

[N,10], numeric format

wotherfs

Risk status of the additional employer (ref. 43)

[N,10], numeric format

wotheraddfs

Risk status of the additional employer’s address (ref. 43)

[N,10], numeric format

mphonefs

Risk status of the mobile phone (ref. 43)

[N,10], numeric format

wphonefs

Risk status of the business phone (ref. 43)

[N,10], numeric format

wphone2fs

Risk status of the business phone 2 (ref. 43)

[N,10], numeric format

wphone3fs

Risk status of the business phone 3 (ref. 43)

[N,10], numeric format

regphonefs

Risk status of the phone at the place of registration (ref. 43)

[N,10], numeric format

livphonefs

Risk status of the phone at the place of residence (ref. 43)

[N,10], numeric format

contphonefs

Risk status of the contact person 1 (ref. 43)

[N,10], numeric format

contphone2fs

Risk status of the contact person 2 (ref. 43)

[N,10], numeric format

contphone3fs

Risk status of the contact person 3 (ref. 43)

[N,10], numeric format

regfs

Risk status of the address at the place of registration (ref. 43)

[N,10], numeric format

adfs

Risk status of the address at the place of residence (ref. 43)

[N,10], numeric format

apnum*

Application No.

[TEXT,20] variable length text format, up to 20 characters

apstatus*

Loan application status (ref. 45)

[N,10], numeric format

apdecisdate*

Date

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

appfs*

Risk status of the application (ref. 43)

[N,10], numeric format

dlamt

Amount issued in UAH

[N,15,2], numeric format with a floating point, 2 digits after the point

</afsubki>

</update>

<liveness> (1) Attributes for the "Liveness detection" report

imgdata0

Base64 (First photo in the series)

[TEXT,~] variable length text format

imgdata1

Base64 (Second photo from the series)

[TEXT,~] variable length text format

imgdata2

Base64 (The third photo in the series)

[TEXT,~] variable length text format

imgdata3

Base64 (The fourth photo in the series)

[TEXT,~] variable length text format

imgdata4

Base64 (Fifth photo from the series)

[TEXT,~] variable length text format

</liveness>

<additionaldata> (1) Attributes for the report “Information on registration of the taxpayer”

source

Name of the source to check (fiskregistration - register of taxpayers, edpod - register of single tax payers, bpartner - tax debt verification)

[TEXT,25] variable length text format, up to 25 characters

</additionaldata>

<additionaldata> (1) VISA card scoring

pan

Encrypted card ID (Encrypted with the VISA public key provided on request)

[TEXT, ~] variable length text format

</additionaldata>

<additionaldata> (1) SME score

datescore

Scoring date

[YYYY-MM-DD], YYYY - year (1920 - 2099), MM - month (01 - 12), DD - day(01-31)

</additionaldata>

<simCheck> Sim-card reissue information

phone

Phone number

[TEXT,40] variable length text format, up to 40 characters

</simCheck>

<additionaldata> FeatureSet

date

Scoring date. Not filled in if the scoring is currently calculated

[YYYY-MM-DD], YYYY - year (1920 - 2099), MM - month (01 - 12), DD - day(01-31)

featlist

List of indicators for calculation. Not to be filled in if all available metrics are calculated

[TEXT] variable length text format

</additionaldata>

<additionaldata> Financial Report

date

Scoring date. Not filled in if the scoring is currently calculated

[YYYY-MM-DD], YYYY - year (1920 - 2099), MM - month (01 - 12), DD - day(01-31)

</additionaldata>

<photocheck> Photo verification LIGHT

photo

Base64(Photo) of the incoming application

[TEXT,~] variable length text format

photoext

Extension of the incoming application’s photo

[TEXT,~] variable length text format

</photocheck>

<declaration> Attributes for searching a declaration document

documentId

Declaration document number

[TEXT,~] variable length text format

</photocheck>

<nameverif> Identification by phone and full name

phone

Phone number (+380…)

[TEXT,50] variable length text format, up to 50 characters

lname*

Last name

[TEXT,40] variable length text format, up to 40 characters

fname*

First name

[TEXT,40] variable length text format, up to 40 characters

mname

Middle name

[TEXT,40] variable length text format, up to 40 characters

</nameverif>

<additionaldata> Attributes for “Entrepreneur Dossier" and “Public Dossier“

usearchive

Indication of using data from the archive in case of unavailability of the USR API (1 - use, 0 - do not use; default 0)

[N,10], numeric format

</additionaldata>

</i>

</request>