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

"ident": {

"okpo": "Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)",

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

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

},

"version": "1.0",

"reqtype": "Template code (Code from the ref.49): 'Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)' - 50",

"reqreason": "Purpose of the request (Code from the ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (we receive it from the API authorization)"

}

}

}

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

"ludomansfreemon": { "found": "Numerical indication of whether a person is found in the register - 0/1"Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), code (0 - No, 1 - Yes)",

"foundreffreemonref": "Textual definition of whether a person is found in the register: Not found (0)/Found (1)", "informationSign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), value (0 - No, 1 - Yes)"

}

}

},

"comp": {

"ludomans":{

"searchTypefound": "Search type Numerical indication of whether a person is found in the register - 0/1/2/3",

"foundref": "Textual definition of whether a person is found in the register: Not found (0)/Found (1)",

"information": {

"searchType": "Search type - 0/1/2/3",

"searchTypeRef": "Text definition of search type: No matches found (0)/Found by TIN (1)/Found by name and date of birth (2)/Found by last name, first name and date of birth (3)",

"lastName": "Last name",

"firstName": "Name",

"middleName": "Middle name",

"dateOfBirth": "Date of birth",

"inn": "TIN",

"documentSeries": "Document series",

"documentNumber": "Document number",

"documentIssuedDate": "Document issue date",

"documentIssuedBy": "Issuer",

"documentOtherData": "Other information about the document",

"passport": "Passport",

"gender": "Sex",

"address": "Address",

"communication": "Contacts",

"stateCode": "Country code",

"rDateFrom": "Period start date",

"rDateTill": "Period end date",

"reason": "Reason"

}

},

"id": "76",

"descr": "Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)"

}

}

}

Request XML

Expand
title body:

<?xml version="1.0" encoding="utf-8"?>

<doc>

<ubki sessid="Session key (we receive it from the API authorization)">

<req_envelope descr="Request envelope">

<req_xml descr="Request object">

<!-- Request Parameters -->

<request version="1.0" reqtype="Template code (Code from the ref.49): 'Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)' - 50" reqreason="Purpose of the request (Code from the ref.24)">

<!-- Parameters, which describe the search criteria-->

<i reqlng="Search criteria language (Code from ref.23)">

<!-- Identification parameters of the subject-->

<ident okpo="Tax/Taxpayer Identification Number (INN-RNUKPN, for individuals)"

lname="**Last name"

fname="**First name"

mname="**Middle name"

bdate="**Date of birth">

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

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>

<!-- Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds) -->

<comp id="76" descr="The name of the component">

<ludomans found="Numerical indication of whether a person is found in the register - 0/1"

foundref="Textual definition of whether a person is found in the register:Not found (0)/Found (1)" >

<information searchType="Search type - 0/1/2/3"

searchTypeRef="Text definition of search type: No matches found (0)/Found by TIN (1)/Found by name and date of birth (2)/Found by last name, first name and date of birth (3)"

lastName="Last name"

firstName="Name"

middleName="Middle name"

dateOfBirth="Date of birth"

inn="TIN"

documentSeries="Document series"

documentNumber="Document number"

documentIssuedDate="Document issue date"

documentIssuedBy="Issuer"

documentOtherData="Other information about the document"

passport="Passport"

gender="Sex"

address="Address"

communication="Contacts"

stateCode="Country code"

rDateFrom="Period start date"

rDateTill="Period end date"

reason="Reason" />

<!--This block must consist of 0 .. * elements-->

</ludomans>

</comp>

</ubkidata>

...