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"

}

}

},

"comp": {

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

}

},

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

...

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"bdate": "19891957-10-0519",
								"mname": "ВАСИЛІВНАІГОРІВНА",
								"fname": "ІРІНААННА",
								"lname": "ГАРНАРИБАЧКА",
								"okpo": "32785082882111118724"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "50",
						"reqreason": "2"
					},
					"descr": "Request object"
				},
				"descr": "Request envelope"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
		}
	}
}

Response JSON

Code Block
{
	"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": {
			"ludomans":{

		  [
            {
                "foundid": 0,
		"76",
                 "foundrefdescr": "NotInformation foundfrom in the registryRegister of ludomaniacs",
		            persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)",
     "information": [] 		         },
			"id"ludomans": "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

Code Block<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
{
                    "found": "1",
             
<req_envelope>
       
<req_xml descr>
"foundref": "A match is found in the registry of ludomaniacs",
                   
<request
 
version=
"
1.0" reqtype="50" reqreason="2">
information": [
                 
<i
 
reqlng="1">
      {
            
<ident bdate="1989-10-05" mname="ВАСИЛІВНА" fname="ІРІНА" lname="ГАРНА" okpo="3278508288" />
                "searchType": "1",
                
</i>
            
</request>
"searchTypeRef": "Found by TIN",
       
</req_xml>
       
</req_envelope>
           
</ubki>
 
</doc>

Response XML

Code Block<?xml
 
version="1.0"
 
encoding=
"
UTF-8
lastName": 
standalone=
"
yes
РИБАЧКА"
?>
,
<ubkidata>
     
<tech>
         
<trace>
             
<step
 
name=
"firstName"
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=
"
76
middleName": 
descr=
""
Information
,
from
 
the
 
Register
 
of
 
persons
 
who
 
have
 
restricted
 
access
 
to
 
gambling
 
establishments
 
and/or
 
participation
 
in
 
gambling
 
(using
 
credit
 
funds)">
         
<ludomans
 
found=
"
0
dateOfBirth"
foundref="Not found in the registry of ludomaniacs" />
: "1957-10-19",
                   
</comp> </ubkidata>

XSD Schema request

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

XSD Schema response

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

Test URL

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

Test data

  • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095" dtype="1" dser="ДО" dnom="270000" cval="+380981220000" ctype="3"

  • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593" dtype="17" dser="" dnom="001013900" cval="+380935171868" ctype="3"

  • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397" dtype="1" dser="СЕ" dnom="311111" cval="+380506630641" ctype="3"

  • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116" dtype="1" dser="КО" dnom="220394" cval="+380971321122" ctype="3"

  • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК" okpo="3333312110" dtype="1" dser="ДД" dnom="222222" cval="+380732144444" ctype="3
             "inn": "2111118724",
                                "documentSeries": "",
                                "documentNumber": "142228",
                                "documentIssuedDate": "",
                                "documentIssuedBy": "",
                                "documentOtherData": "",
                                "passport": "",
                                "gender": "",
                                "address": "",
                                "communication": "E-mail:test@gmail.com, Тел.:0501111111, Поштова адреса:11111",
                                "stateCode": "",
                                "rDateFrom": "2024-04-29",
                                "rDateTill": "2027-04-28",
                                "reason": "~ Рішення КРАІЛ від 16.05.2024 про розгляд заяви про обмеження. "
                            }
                        ]
                    }
                }
            ]
        }
    }

    Request XML

    Code Block
    <?xml version="1.0" encoding="UTF-8"?>
    <doc>
       <ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
          <req_envelope>
             <req_xml descr>
                <request version="1.0" reqtype="50" reqreason="2">
                   <i reqlng="1">
                      <ident bdate="1957-10-19" mname="ІГОРІВНА" fname="АННА" lname="РИБАЧКА" okpo="2111118724" />
                   </i>
                </request>
             </req_xml>
          </req_envelope>
       </ubki>
    </doc>

    Response XML

    Code Block
    <?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="76" descr="Information from the Register of persons who have restricted access to gambling establishments and/or participation in gambling (using credit funds)">
            <ludomans found="1" foundref="A match is found in the registry of ludomaniacs">
                <information searchType="1" searchTypeRef="Found by TIN" lastName="РИБАЧКА" firstName="АННА" middleName="" dateOfBirth="1957-10-19" inn="2111118724" documentSeries="" documentNumber="142228" documentIssuedDate="" documentIssuedBy="" documentOtherData="" passport="" gender="" address="" communication="E-mail:test@gmail.com, Тел.:0501111111, Поштова адреса:11111" stateCode="" rDateFrom="2024-04-29" rDateTill="2027-04-28" reason="~ Рішення КРАІЛ від 16.05.2024 про розгляд заяви про обмеження. "/>
            </ludomans>
    </ubkidata>

    Test URL

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

    Test data

    Not found in the register

    • bdate="1991-03-30" mname="ПЕТРОВИЧ" fname="ВАДИМ" lname="НИКОЛАЕВ" okpo="3332643095"

    • bdate="1974-08-20" mname="БОГДАНОВИЧ" fname="БОГДАН" lname="БОГДАНОВ" okpo="2726020593"

    • bdate="1981-05-20" mname="ПЕТРОВНА" fname="МАРИЯ" lname="ИВАНЦОВА" okpo="2972566397"

    • bdate="1988-07-10" mname="ІВАНОВИЧ" fname="БОГДАН" lname="ПОШТАР" okpo="3233312116"

    • bdate="1985-03-20" mname="НИКИФОРОВНА" fname="АННА" lname="ЯРЦЕВА" okpo="3112579786" dtype="1" dser="СЮ" dnom="170000" cval="+380981224895" ctype="3"

    • bdate="19571989-10-1905" mname="ІГОРЕВНАВАСИЛІВНА" fname="АННАІРІНА" lname="РИБАЧКАГАРНА" okpo="2111118724" dtype="1" dser="ВВ" dnom="142228" cval="+380662134234" ctype="3"3278508288"

    Found in the registry by TIN

    • bdate="19891957-10-0519" mname="ВАСИЛІВНАІГОРЕВНА" fname="ІРІНААННА" lname="ГАРНАРИБАЧКА" okpo="3278508288" dtype="1" dser="АМ" dnom="578072" cval="+380962134234" ctype="32111118724"

    Found in the register by last name, first name and date of birth

    • bdate="1991-04-06" mname="ВОЛОДИМИРОВИЧ" fname="ВОЛОДИМИР" lname="ТКАЧУК"