Versions Compared

Version Old Version 1 New Version Current
Changes made by

Валентин Токарь

Валентин Токарь

Saved on

Key

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

...

Info

Звіт містить такі компоненти:

Http Method

POST

Request URL

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

Request JSON
( ** параметри передаються опціонально)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "**ІПН/ЄДРПОУ суб'єкта",

"lname": "**Прізвище",

"fname": "**Ім'я",

"mname": "**По батькові",

"bdate": "**Дата народження"

},

"reqlng": "Мова критеріїв пошуку (Код із дов.23)"

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Ідентифікація за номером телефону та ПІБ'Пов'язані особи' - 5253",

"reqreason": "Мета подання запиту (Код із дов.24)"

},

"descr": "Об'єкт запиту"

},

"descr": "Конверт запиту"

},

"sessid": "Сесійний ключ (отримуємо із API авторизації)"

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Найменування кроку",

"stm": "Дата штамп старту кроку",

"ftm": "Дата штамп фінішу кроку"

}

},

"error": {

"errtype": "Код помилки(Код із дов.0)",

"errtext": "Текст помилки(Значення із дов.0)"

},

"reqinfo": {

"reqid": "Вихідний ІД запиту, згенерований УБКІ"

},

"billing": {

"balance": {

"value": "Сума балансу",

"date": "Дата",

"time": "Час"

},

"billdetails": {

"freemon": "Ознака безоплатності за типом запиту "Моніторинг ‘Моніторинг клієнта організації" ' (reqreason=1), код (0 - Ні, 1 - Так)",

"freemonref": "Ознака безоплатності за типом запиту "Моніторинг ‘Моніторинг клієнта організації" організації’ (reqreason=1), значення (0 - Ні, 1 - Так)"

}

}

},

"comp": [ {

"idrelatedPersons": "79",{

"descrrelated": "Назва компоненти",{

"relatedPersonsrelations": {

"bdateaccuracy": "Дата народження суб'єкта, що була передана у запитіТочність знайденого зв'язку, від 0 до 1",

"fnamerole": "ІмОпис зв'я язку між суб'єкта, що було передано у запитієктом пошуку та знайденою особою",

"lnameroleCode": "Прізвище суб'єкта, що було передано у запитіКод опису зв'язку між суб'єктом пошуку та знайденою особою (Код із дов.73)",

"mnamesource": "По-батькові суб'єкта, що було передано у запиті",

"subjectCode": "ІПН фізичної особи або ЄДРПОУ юридичної особи, що були передані при запиті",

"related": [{ Джерело в якому було знайдено зв'язок (Код із дов.72)"

},

"code": "Код ЄДРПОУ пов'язаної юридичної особиособи, якщо це юридична особа",

"name": "Найменування Назва юридичної особи за джерелом або ПІБ фізичної особи, що яка пов'язані язана із суб'єктом"

},

"relationsbdate": [{ "Дата народження суб'єкта",

"accuracylname": Точність визначеного зв'язку (від 0 до 1)"Прізвище",

"rolefname": "Опис зв'язку між суб'єктом пошуку та знайденою особоюІм'я",

"sourcemname": "Джерело в якому було знайдено зв'язок (Довідник 72)"

}

]

}

]

}

}

]По батькові",

"subjectCode": "ІПН/ЄДРПОУ суб'єкта"

},

"id": "79",

"descr": "Назва компоненти"

}

}

}

Request XML
( ** параметри передаються опціонально)

Expand
title body:

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

<doc>

<ubki sessid="Сесійний ключ (отримуємо із API авторизації)">

<req_envelope descr="Конверт запиту">

<req_xml descr="Об'єкт запиту">

<!-- Параметри запиту -->

<request version="1.0"

reqtype="Код шаблону (Код із дов.49): Звіт 'Ідентифікація за номером телефону та ПІБ'Пов'язані особи' - 5253"

reqreason="Мета подання запиту (Код із дов.24)">

<!-- Параметри, що описують критерії пошуку-->

<i reqlng="Мова критеріїв пошуку (Код із дов.23)">

<!-- Параметри ідентифікації суб'єкта-->

<ident okpo="**ІПН/ЄДРПОУ суб'єкта" 

                     lname="**Прізвище" 

                     fname="**Ім'я" 

                     mname="**По батькові"

bdate="**Дата народження"/>

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

Expand
titlebody:

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

<ubkidata>

<!-- Блок системної інформації -->

<tech>

<trace>

<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку">

<!-- Блок trace містить метрики таймінгу кроків формування компонентів -->

</step>

</trace>

<error errtype="Код помилки(Код із дов.0)" errtext="Текст помилки(Значення із дов.0)">

</error>

<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ">

</reqinfo>

<!-- Блок інформації щодо поточного стану рахунку припейд-->

<billing>

<balance value="Сума балансу" date="Дата" time="Час" />

<billdetails freemon="Ознака безоплатності за типом запиту "Моніторинг ‘Моніторинг клієнта організації" організації’ (reqreason=1), код (0 - Ні, 1 - Так)"

freemonref="Ознака безоплатності за типом запиту " 'Моніторинг клієнта організації" ' (reqreason=1), значення (0 - Ні, 1 - Так)"/>

</billing>

</tech>

<!-- Пов'язані особи-->

<comp id="79" descr="Назва компоненти">

<relatedPersons bdate="Дата народження суб'єкта"

lname="Прізвище"

fname="Ім'я"

mname="По батькові"

subjectCode="ІПН/ЄДРПОУ суб'єкта" >

<related code="ЄДРПОУ особи, якщо це юридична особа"

name="Назва юридичної особи або ПІБ фізичної особи, яка пов'язана із суб'єктом"

>

<relations accuracy="Точність >

<!--Даний блок може і повинен складатися з 0 .. * елементів-->

<relations accuracy="Точність знайденого зв'язку, від 0 до 1."

role="Опис зв'язку між суб'єктом пошуку та знайденою особою"

roleCode="Код опису зв'язку між суб'єктом пошуку та знайденою особою (Код із дов.73)"

source="Джерело в якому було знайдено зв'язок (Довідник Код із дов.72)" />

<!--Даний блок може і повинен складатися з 0 .. * елементів-->

</related>

</relations>

<!--Даний блок може і повинен складатися з 0 .. * елементів-->

</related>

</relatedPersons>

</relatedPersons>

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "1234567890"2726020593"
							},
								"lnamereqlng": "1",
						},
						"fnameversion": "1.0",
								"mnamereqtype": "53",
								"bdatereqreason": "2"
							}},
							"reqlngdescr": "1Об'єкт запиту"
						},
						"versiondescr": "1.0",
						"reqtype": "53",
						"reqreason": "2"
		Конверт запиту"
			},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
		}
	}
}

Response JSON

Code Block{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-11-09 19:22:31.946", "ftm": "2022-01-09 19:22:32.021" } }, "reqinfo": { "reqid": "req2#000002007864" } }, "comp": [ { "id": "79", "descr": "Пов'язані особи", "relatedPersons": { "bdate": "", "fname": "", "lname": "", "mname": "", "subjectCode": "1234567890", "related": [ { "code": "", "name": "НИКОЛАЕВ ВАДИМ ПЕТРОВИЧ", "relations": [ { "accuracy": 1.0, "role": "керівник", "source": "EDR_main" 
"sessid": "7BD7E136E3BF470EAA2CFE2E8700000D"
		}
	}
}

Response JSON

Code Block
{
	"ubkidata": {
		"tech": {
			"trace": {
				"step":  [
                    {
					"name": "build report",
					"stm": "2022-11-09 19:22:31.946",
					"ftm": "2022-01-09 19:22:32.021"
				}
			 ]
               },
          ]  "error": [],
			"reqinfo": {
				"reqid": "req2#000002007864"
			}
		},
		"comp": [
            {
},                "id": "79",
       {         "descr":   "Пов'язані особи",
                "coderelatedPersons": "",
       {
                    "namebdate": "КОМПАНІЯ \"РОМАШКА ІНКОРПОРЕЙТЕД\"","1974-08-20",
                    "fname": "БОГДАН",
         "relations": [          "lname": "БОГДАНОВ",
                     {"mname": "БОГДАНОВИЧ",
                    "subjectCode": "2726020593",
              "accuracy": 1.0,     "related": [
                        {
     "role": "засновник",                      "code": "44011074",
             "source": "EDR_main"              "name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"ЛИМАК ГРУП\"",
            }                "relations": [
           ]                     {
   },                         {        "accuracy": 1.0,
                   "code": "12345632",                "role": "суб'єкт є керівником особи",
        "name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"ВАСИЛЬКІ\"",                       "roleCode": "203",
    "relations": [                               "source": "EDR_links"
{                                },
    "accuracy": 1.0,                           {
         "role": "засновник",                          "accuracy": 1.0,
         "source": "EDR_links"                          "role": "суб'єкт є засновником особи",
  }                             ]     "roleCode": "202",
                  }                    "source": "EDR_links"
  ]                 }             }
         ]       } }

Request XML

Code Block<?xml
version="1.0"
encoding="UTF-8"?>
<doc>
<ubki
sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
    ]
<req_envelope
descr="Конверт
запиту">
<req_xml
descr="Об'єкт
запиту">
<request
version="1.0"
reqtype="53"
reqreason="2">
 }
<i
reqlng="1">
          ]
<ident
okpo="1234567890"
lname=""
fname=""
mname=""
pbdate=""
/>
        }
</i>
</request>
 }
</req_xml>
   ]
</req_envelope>
</ubki> </doc>Response 
}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8
" standalone="yes
"?>
<ubkidata>
<doc>
<tech> 
<ubki sessid="7BD7E136E3BF470EAA2CFE2E8700000D">
<trace>
 <req_envelope 
descr="Конверт запиту">
<step
name="build
report"
stm="2022-11-09 19:22:31.946" ftm="2022-01-09 19:22:32.021" />
 <req_xml descr="Об'єкт запиту">
</trace>
   <request
<reqinfo reqid="req2#000002007864" /> </tech> <comp id="79" descr="Пов'язані особи">
version="1.0" reqtype="53" reqreason="2">
          <i reqlng="1">
<relatedPersons
bdate=""
fname="" lname="" mname
 <ident okpo="2726020593"
subjectCode="1234567890"
/>
          </i>
<related
code="" name="НИКОЛАЕВ ВАДИМ ПЕТРОВИЧ"> 
     </request>
      </req_xml>
    </req_envelope>
<relations accuracy
</ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" roleencoding="керівникUTF-8" sourcestandalone="EDR_mainyes"/?>
          <ubkidata>
 </related> <tech>
    <trace>
      <related<step codename="build report" name="КОМПАНІЯ &quot;РОМАШКА ІНКОРПОРЕЙТЕД&quot;">
stm="2022-11-09 19:22:31.946" ftm="2022-01-09 19:22:32.021" />
    </trace>
    <reqinfo reqid="req2#000002007864" />
  </tech>
   <comp  <relations accuracyid="1.079" roledescr="засновник" source="EDR_main"/>Пов'язані особи">
        <relatedPersons bdate="1974-08-20" fname="БОГДАН" lname="БОГДАНОВ"  </related>mname="БОГДАНОВИЧ" subjectCode="2726020593">
            <related code="1234563244011074" name="ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ &quot;ВАСИЛЬКІЛИМАК ГРУП&quot;">
                <relations accuracy="1.0" roleCode="203" role="суб'єкт є керівником особи" source="EDR_links"/>
                <relations accuracy="1.0" roleCode="202" role="засновниксуб'єкт є засновником особи" source="EDR_links"/>
            </related>
        </relatedPersons>
    </comp>
</ubkidata>

XSD Schema request

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

request52

request53.xsd

XSD Schema response

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

response52.xsd

response53.xsd

Test URL

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

Test data

  • okpo="3332643095"

  • okpo="2726020593"

  • okpo= "12345632"