Versions Compared

Old Version 8

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.

...

Info

The report contains the following components:

Http Method

POST

Request URL

https://secure.ubki.ua/upload/data

/xml

Request JSON (headers: "SessId: Session key (obtained from the authorization API)", "Content-Type: application/json")

Expand
title body:

{

"reqtype": "Information processing mode (code from ref.50)",

"reqidout": "Organization request

ID”

ID",

"reqreason": "Request objective (code from ref.24): Data transfer – 0",

"delreason": "The reason for deleting data, in mode d(code from ref.62)",

"data": {

"fo_cki": {

"inn": "TIN of the credit history subject",

"person_id":  "Unique identifier of a person",

 "is_gone": "Mark about the death of a person, where 0- alive, 1 - deceased (the field is mandatory for transfer) (code from the ref.56)",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"

lng

reqlng": "Part presentation language (code from ref.23)",

"idents": [

{

"vdate": "Date of the information from this part",

"lng": "Part presentation language (code from ref.23)",

"inn": "TIN of the credit history subject",

"lname": "Last name",

"fname": "First name",

"mname": "Middle name",

"bdate": "Date of birth",

"csex": "Sex (code from ref.1)",

"family": "Marital status (code from ref.2)",

"ceduc": "Education (code from ref.3 (ISO 3166))",

"cgrag": "Citizenship (code from ref.4)",

"spd": "Presence of the business entity’s registration (code from ref.5)",

"sstate": "Social status (code from ref.6)",

"cchild": "Number of children"

}

],

"docs": [

{

"vdate": "Date of the information from this part",

"lng": "Part presentation language (code from ref.23)",

"dtype": "Document type (code from ref.7)",

"dser": "Document series",

"dnom": "Document number",

"

dterm

eddr_number": "

Expiration date

Unique record number in the Unified State Demographic Register",

"dterm": "Expiration date",

"dwho": "Document issuer",

"dwdt": "Document issue date"

}

],

"addrs": [

{

"vdate": "Date of the information from this part",

"lng": "Part presentation language (code from ref.23)",

"adtype": "Address type (code from ref.9)",

"adcountry": "Country (

two-character

Digital code from ISO 3166

reference book

)",

"adindex": "Postal code",

"adstate": "Region",

"adarea": "District",

"adcity": "Locality",

"adcitytype": "Locality type (code from ref.22)",

"adstreet": "Street",

"adhome": "House",

"adcorp": "Block",

"adflat": "Flat",

"addrdirt": "Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)"

}

],

"works": [

{

"vdate": "Date of the information from this part",

"lng": "Part presentation language (code from ref.23)",

"cdolgn": "Official position (code from ref.8)",

"wokpo": "EDRPOU of the employer",

"wname": "Name of the employer in the base language",

"wstag": "Length of service, years completed",

"wdohod": "Client’s monthly income"

}

],

"fotos": [

{

"vdate": "Date of the information from this part",

"foto": "base64 (Photo)"

}

],

"deals": [

{

"deal":

{

"dlref": "Transaction ID",

"dlds": "Transaction commencement date",

"dlcelcred": "Transaction type (code from ref.17)",

"dlvidobes": "Type of collateral (code from ref.15)",

"dlporpog": "Redemption plan (code from ref.18)",

"dlcurr": "Transaction currency (code from ref.12)",

"dlamt": "Transaction amount (initial)",

"dlrolesub": "Subject’s role (code from ref.14)",

"dlamtobes": "Collateral value in base currency",

"deallife": [

{

"dlmonth": "Data period (month)",

"dlyear": "Data period (year)",

"dlflstat": "Transaction status in the current period (code from ref.16)",

"dldpf": "Transaction closing date under the contract",

"dldff": "Actual transaction end date",

"dlkontragent": "OKPO of a new lender/old lender (mandatory if the transaction status is sold / bought)",

"dlsale_date": "Date of sale (required for sale from 15.03.2021)",

"dlsale_name": "Full name of the legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)",

"dlsale_addr": "Location of a legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)",

"dlsale_email": "E-mail address (mandatory when selling / buying a contract to a legal entity from 15.03.2021)",

"dlsale_phone": "Phone number (mandatory when selling / buying a contract to a legal entity from 15.03.2021)",

"dlamtlim": "Current transaction limit (for renewable transactions, credit cards)",

"dlamtpaym": "Planned compulsory payment amount in the current period",

"dlamtcur": "Current debt amount",

"dlamtexp": "Current debt overdue amount",

"dldayexp": "Current number of days overdue",

"dlflpay": "Indication of payment made in the current period (code from ref.13)",

"dlflbrk": "Indication of arrears present in the current period (code from ref.13)",

"dlfluse": "Indication of the credit tranche in the current period (code from ref.13)",

"dldateclc": "Calculation date"

}

]

}

}

],

"contacts": [

{

"vdate": "Date of the information from this part",

"ctype": "Contact type (code from ref.10)",

"cval": "Contact value"

}

]

}

}

}

Response JSON

Expand
titlebody:

{

"reqinfo": {

"reqid": "Outgoing request ID generated by UBKI",

"reqidout": "Outgoing request ID generated by the company"

},

"http_status": "http response code",

"sentdatainfo": {

"state": "Batch status (sy – system error in UBKI services, ok – success, er – error, nt – success with a remark)",

"main_errcode": "The most critical error code of all package validations",

"inn": "TIN of the creditor",

"sy": "system error of the UBKI services, send the batch again, if the error repeats, suspend sending new batches, until you clarify the reasons with the Bureau",

"ok": "number of components accepted without remarks",

"nt": "number of components accepted with remarks",

"ig": "number of components unaccepted/declined/ignored",

"er": "number of components with critical errors, leading to rejection of the whole batch",

"items": [

{

"compid": "Component group number",

"tag": "Tag",

"errtype": "Error or comment level",

"errcode": "Error or comment number",

"attr": "Attribute",

"msg": "Message text"

}

]

},

"trace": {

"steps": [

{

"name": "Stage name",

"start": "Time to start processing this step",

"finish": "Time to finish processing this step",

"duration": "Duration of stage processing"

}

]

}

}

Request XML

Expand
title 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="Information processing mode (code from ref.50)"

delreason="The reason for deleting data, in mode d(code from ref.62)"

reqreason="Request objective (code from ref.24): Data transfer – 0">

<ubkidata>

<comp id="1" descr="Names of components">

<!-- Identification part -->

<!-- This part must contain one item -->

<cki inn="TIN of the credit history subject/EDRPOU of the legal entity"

person_id="Unique identifier of a person"

 is_gone="Mark about the death of a person, where 0- alive, 1 - deceased (the field is mandatory for transfer) (code from the ref.56)"

lname="Last name/Name of the legal entity"

fname="First name"

mname="Middle name"

reqlng="Search language (while searching)/Identification language (during transfer) (code from ref.23)"

bdate="Date of birth">

<!-- This part can and must contain 1..* items -->

<ident vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

inn="TIN of the credit history subject"

lname="Last name"

fname="First name"

mname="Middle name"

bdate="Date of birth"

csex="Sex (code from ref.1)"

family="Marital status (code from ref.2)"

ceduc="Education (code from ref.3)"

cgrag="Citizenship (code from ref.4 (ISO 3166))"

spd="Presence of the business entity’s registration (code from ref.5)"

sstate="Social status (code from ref.6)"

cchild="Number of children">

</ident>

<!-- History of the Information about Employment part -->

<!-- Employment part can contain 0..* -->

<work vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

cdolgn="Official position (code from ref.8)"

wokpo="EDRPOU of the employer"

wname="Name of the employer in the base language"

wstag="Length of service, years completed"

wdohod="Client’s monthly income">

</work>

<!-- History of the Information about Documents part -->

<!--This part must contain 1..* units and at least one document-->

<doc vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

dtype="Document type (code from ref.7)"

dser="Document series"

dnom="Document number"

eddr_number="Unique record number in the Unified State Demographic Register"

dterm="Expiration date"

dwho="Document issuer"

dwdt="Document issue date">

</doc>

<!-- History of the Information about Addresses part -->

<!--This part must contain 1..* units and at least one address-->

<addr vdate="Date of the information from this part"

lng="Part presentation language (code from ref.23)"

adtype="Address type (code from ref.9)"

adcountry="Country (

two-character

Digital code from ISO 3166

reference book

)"

adindex="Postal code"

adstate="Region"

adarea="District"

adcity="Locality"

adcitytype="Locality type (code from ref.22)"

adstreet="Street"

adhome="House"

adcorp="Block"

adflat="Flat"

addrdirt="Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019)">

</addr>

<!-- Photo History part -->

<!--This part can contain 0..* items-->

<foto vdate="Date of the information from this part"

inn="TIN of the credit history subject"

foto="base64 (Photo)">

</foto>

</cki>

</comp>

<comp id="2" descr="Names of components">

<!-- Information about Credit Transactions part -->

<!--This part must contain 1..* items-->

<crdeal dlref="Transaction ID"

lng="Part presentation language (code from ref.23)"

inn="TIN of the credit history subject/EDRPOU of the legal entity"

lname="Last name/Name of the legal entity"

fname="First name"

mname="Middle name"

bdate="Date of birth"

dlcelcred="Transaction type (code from ref.17)"

dlvidobes="Type of collateral (code from ref.15)"

dlporpog="Redemption plan (code from ref.18)"

dlcurr="Transaction currency (code from ref.12)"

dlamt="Transaction amount (initial)"

dlrolesub="Subject’s role (code from ref.14)"

dlamtobes="Collateral value in base currency">

<!-- Credit History Variable Values part -->

<deallife dlref="Transaction ID"

dlmonth="Data period (month)"

dlyear="Data period (year)"

dlds="Transaction commencement date"

dldpf="Transaction closing date under the contract"

dldff="Actual transaction end date"

dlflstat="Transaction status in the current period (code from ref.16)"

dlkontragent="OKPO of a new lender/old lender (mandatory if the transaction status is sold / bought)"

dlsale_date="Date of sale (required for sale from 15.03.2021)"

dlsale_name="Full name of the legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_addr="Location of a legal entity (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_email="E-mail address (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlsale_phone="Phone number (mandatory when selling / buying a contract to a legal entity from 15.03.2021)"

dlamtlim="Current transaction limit (for renewable transactions, credit cards)"

dlamtpaym="Planned compulsory payment amount in the current period"

dlamtcur="Current debt amount" dlamtexp="Current debt overdue amount"

dldayexp="Current number of days overdue"

dlflpay="Indication of payment made in the current period (code from ref.13)"

dlflbrk="Indication of arrears present in the current period (code from ref.13)"

dlfluse="Indication of the credit tranche in the current period (code from ref.13)"

dldateclc="Calculation date">

</deallife>

</crdeal>

</comp>

<comp id="10" descr="Names of components">

<!-- History of the Information about Contacts part -->

<!--This part must contain 1..* units and at least one contact-->

<cont inn="TIN of the credit history subject/EDRPOU of the legal entity"

vdate="Date of the information from this part"

ctype="Contact type (code from ref.10)"

cval="Contact value">

</cont>

</comp>

</ubkidata>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

<TECH>

<!-- A report on data request-to-send result will be included in the response XML, tag-->

<!-- Development Time Statistics from the UBKI Side part-->

<trace>

<step name="START" stm="1574049134.650" ftm="1574049134.651" />

<step name="FINISH" stm="1574049134.650" ftm="1574049135.224" />

</trace>

<!-- should be completed if a system error occurs, and it is impossible to continue successful transfer of batches (for example, when the session key expires) -->

<error errtext="" errtype="numeric error code (ref.0)" />

<!--Report on data request-to-send result-->

<sentdatainfo reqid="Outgoing request ID generated by UBKI"

state="Batch status (sy – system error in UBKI services, ok – success, er – error, nt – success with a remark)"

sy="system error of the UBKI services, send the batch again, if the error repeats, suspend sending new batches, until you clarify the reasons with the Bureau"

ok="number of components accepted without remarks"

nt="number of components accepted with remarks"

ig="number of components unaccepted/declined/ignored"

er="number of components with critical errors, leading to rejection of the whole batch"

errtype="Maximum error code of all component errors">

<item compid="Component ID"

tag="Tag"

attr="Attribute"

code="sy – system error of the UBKI services, er – critical error, ig – declined with a remark, nt – accepted with a remark"

msg="Message text"

errtype="All errors and

/or notifications from the directory" />

</sentdatainfo>

</TECH>

Example

Request

/or notifications from the directory" />

</sentdatainfo>

</TECH>

Example

Request JSON

Code Block
{
  "reqtype": "i",
  "reqidout": "c9a961b00b8245b9af6d63d9db1",
  "reqreason": "0",
  "data": {
    "fo_cki": {
      "reqlng": "1",
      "inn": "1234567890",
      "person_id": "1-АА-111111",
      "is_gone": "0",
      "lname": "Іванов",
      "fname": "Іван",
      "mname": "Іванович",
      "bdate": "1981-04-16",
      "idents": [
        {
          "lng": "1",
          "vdate": "2019-02-19",
          "inn": "1234567890",
          "lname": "Іванов",
          "fname": "Іван",
          "mname": "Іванович",
          "bdate": "1981-04-16",
          "csex": "1",
          "cgrag": "804",
          "family": "2",
          "ceduc": "3",
          "spd": "1",
          "sstate": "3",
          "cchild": "0"
        }
      ],
      "docs": [
        {
          "lng": "1",
          "vdate": "2017-04-07",
          "dtype": "1",
          "dser": "АА",
          "dnom": "111111",
          "eddr_number": "19810416-07789",
          "dwho": "Луцкім МВ УДМС України у Волинській області",
          "dterm": "",
          "dwdt": "2014-10-01"
        }
      ],
      "addrs": [
        {
          "vdate": "2017-04-07",
          "lng": "1",
          "adtype": "2",
          "adcountry": "UA",
          "adindex": "43000",
          "adstate": "Волинська",
          "adarea": "Луцьк (служ.)",
          "adcity": "Луцьк м.",
          "adcitytype": "4",
          "adstreet": "Науки просп.",
          "adhome": "1",
          "adcorp": "",
          "adflat": "83",
          "addrdirt": "25012, м.Луцьк, вул.Волинська буд.1 кв.83"
        }
      ],
      "deals": [
        {
          "dlref": "1254789/1",
          "dlds": "2018-12-03",
          "dlcelcred": "10",
          "dlvidobes": "90",
          "dlporpog": "8",
          "dlcurr": "980",
          "dlamt": "1000.00",
          "dlrolesub": "1",
          "dlamtobes": "1000.00",
          "deallife": [
            {
              "dlmonth": "12",
              "dlyear": "2018",
              "dldpf": "2018-12-18",
              "dldff": "",
              "dlflstat": "1",
              "dlamtlim": "1000.00",
              "dlamtpaym": "793.20",
              "dlamtcur": "1793.20",
              "dlamtexp": "1793.20",
              "dldayexp": "13",
              "dlflpay": "0",
              "dlflbrk": "1",
              "dlfluse": "0",
              "dldateclc": "2019-02-19"
            }
          ]
        }
      ],
      "contacts": [
        {
          "vdate": "2019-02-13",
          "ctype": "3",
          "cval": "380710000000"
        }
      ]
    }
  }
}

Response JSON

Code Block
{
    "reqinfo": {
        "reqid": "IN#O381G01204940",
        "reqidout": "c9a961b00b8245b9af6d63d9db1"
    },
    "http_status": 200,
    "sentdatainfo": {
        "inn": "1234567890",
        "ok": 7,
        "nt": 0,
        "ig": 0,
        "er": 0,
        "sy": 0,
        "items": [],
        "reqid": "IN#O381G01204940",
        "reqidout": "c9a961b00b8245b9af6d63d9db1",
        "state": "ok",
        "main_errcode": 0
    },
    "trace": {
        "steps": [
            {
                "name": "START",
                "start": "2023-07-26 17:06:33",
                "finish": "2023-07-26 17:06:33",
                "duration": 1
            },
            {
                "name": "FINISH",
                "start": "2022-08-01 16:40:05",
                "finish": "2022-08-01 16:40:05",
                "duration": 1014
            }
        ]
    }
}

Request XML

Code Block
<!--?xml version="1.0" encoding="UTF-8"?-->
<doc>
  <ubki sessid="BB0CC999E5024D01B125EC1060000B09">
    <req_envelope>
      <req_xml>
        <request version="1.0" reqtype="i" reqreason="0">
          <ubkidata>
            <comp id="1">
              <cki reqlng="1" inn="1234567890" person_id="1-АА-111111" is_gone="0" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16">
                <doc lng="1" vdate="2017-04-07" dtype="1" dser="АА" dnom="111111" eddr_number="12345678-12345" dwho="Луцкім МВ УДМС України у Волинській області" dwdt="2014-10-01">
                </doc>
                <ident lng="1" vdate="2019-02-19" inn="1234567890" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16" csex="1" cgrag="804">
                </ident>
                <addr vdate="2017-04-07" lng="1" adtype="2" adcountry="UA" adindex="43000" adstate="Волинська" adarea="Луцьк (служ.)" adcity="Луцьк м." adcitytype="4" adstreet="Науки просп." adhome="1" adcorp="" adflat="83" />
              </cki>
            </comp>
            <comp id="2">
              <crdeal dlref="1254789/1" lng="1" inn="1234567890" lname="Іванов" fname="Іван" mname="Іванович" bdate="1981-04-16" dlcelcred="10" dlvidobes="90" dlporpog="8" dlcurr="980" dlamt="1000.00
" dldonor=
"
BNK"
 dlrolesub="1" dlamtobes="1000.00">
                <deallife dlref="1254789/1" dlmonth="12" dlyear="2018" dlds="2018-12-03" dldpf="2018-12-18" dldff="" dlflstat="1" dlkontragent="" dlamtlim="1000.00" dlamtpaym="793.20" dlamtcur="1793.20" dlamtexp="1793.20" dldayexp="13" dlflpay="0" dlflbrk="1" dlfluse="0" dldateclc="2019-02-19">
                </deallife>
              </crdeal>
            </comp>
            <comp id="10">
              <cont inn="1234567890" vdate="2019-02-13" ctype="3" cval="380710000000">
              </cont>
            </comp>
          </ubkidata>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<doc>
  <tech>
    <trace>
      <step name="START" stm="1659361205.224" ftm="1659361205.224" start="2022-08-01 16:40:05" finish="2022-08-01 16:40:05" duration="0000000" />
      <step name="FINISH" stm="1659361205.224" ftm="1659361205.653" start="2022-08-01 16:40:05" finish="2022-08-01 16:40:05" duration="0000429" />
    </trace>
    <reqinfo reqid="IN#O381G01204940" />
    <error errtype="" />
    <sentdatainfo reqid="IN#O381G01204940" state="ok" errtype="0" inn="1234567890" reqidout="" ok="6" nt="0" ig="0" er="0" sy="0" />
  </tech>
</doc>

XSD Schema request

https://secure.ubki.ua/upload.xsd

XSD Schema response

https://secure.ubki.ua/response.xsd

Test URL

https://test.ubki.ua/upload/data

/xml

...

See also in this section

Legal entity

...

Introduction

Receiving information

Service "Monitoring subjects"

Testing environment

References

...