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": "**ІПН/ЄДРПОУ суб'єкта",

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

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

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

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

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): Звіт 'Пов'язані особи' - 53",

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

"relatedPersons": {

"related": {

"relations": {

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

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

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

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

},

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

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

},

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

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

"fname": "Ім'я",

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

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

},

"id": "79",

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

}

}

}

...

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="Назва юридичної особи або ПІБ фізичної особи, яка пов'язана із суб'єктом" >

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

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

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

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

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

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

</related>

</relatedPersons>

</comp>

</ubkidata>

...

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": "Пов'язані особи",
                "relatedPersons": {
                    "bdate": "1974-08-20",
                    "fname": "БОГДАН",
                    "lname": "БОГДАНОВ",
                    "mname": "БОГДАНОВИЧ",
                    "subjectCode": "2726020593",
                    "related": [
                        {
                            "code": "44011074",
                            "name": "ТОВАРИСТВО З ОБМЕЖЕНОЮ ВІДПОВІДАЛЬНІСТЮ \"ЛИМАК ГРУП\"",
                            "relations": [
                                {
                                    "accuracy": 1.0,
                                    "role": "представник юридичноїсуб'єкт є керівником особи",
                                    "roleCode": "203",
                                    "source": "EDR_links""
                                },
                                {
    },                                 {"accuracy": 1.0,
                                    "accuracyrole": 1.0"суб'єкт є засновником особи",
                                    "roleroleCode": "є засновником202",
                                    "source": "EDR_links"
                                }
                            ]
                        }
                    ]
                }
            }
        ]
    }
}

...

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-11-09 19:22:31.946" ftm="2022-01-09 19:22:32.021" />
    </trace>
    <reqinfo reqid="req2#000002007864" />
  </tech>
   <comp id="79" descr="Пов'язані особи">
        <relatedPersons bdate="1974-08-20" fname="БОГДАН" lname="БОГДАНОВ" mname="БОГДАНОВИЧ" subjectCode="2726020593">
            <related code="44011074" 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>

...