Versions Compared

Key

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

...

Request XML
( ** parameters are passed optionally)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "Taxpayer Identification Number (TIN) /USREOU",

"lname": "**Last name",

"fname": "**First name",

"mname": "**Middle name",

"bdate": "**Date of birth"

},

"additionaldata": {

"source": "**Name of the register for verification (fiskregistration - Register of Taxpayers, edpod - Register of Single Taxpayers, bpartner - Tax Debt Check)"

},

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

},

"version": "1.0",

"reqtype": "Template code (code from ref.49): Taxpayer registration information' - 36",

"reqreason": "Request objective (code from ref.24)"

},

"descr": "Request object"

},

"descr": "Request envelope"

},

"sessid": "Session key (obtained from the authorization API)"

}

}

}

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"

},

"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": "Ознака безоплатності за типом запиту ’Моніторинг клієнта організації’ (reqreason=Sign of free of charge according to the request type "Monitoring the client of the organization" (reqreason=1), значення value (0 - НіNo, 1 - ТакYes)"

}

}

},

"comp": {

"taxagent": {

"okpo": "РНОКПП Taxpayer Identification Number (ІПНTIN) /ЄДРПОУ суб’єкта із запитуUSREOU",

"found": "Availability of taxpayer registration information, numeric value: -2/-1/0/1 - чисельне визначення факту реєстрації суб’єкта як платника податків",

"foundref": "Текстове визначення факту реєстрації суб’єкта як платника податків (Код із довAvailability of taxpayer registration information, text value (code from ref.58)",

"source": "Найменування джерела данихName of the data source, text value",

"response": "Відповідь АПІ у форматі jsonTaxpayer registration information in JSON format"

},

"id": "48",

"descr": "Інформація про реєстрацію платника податківTaxpayer registration information"

}

}

}

Request XML
( **

параметри передаються опціонально

parameters are passed optionally)

Expand
title body:

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

<doc>

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

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

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

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

<request version="1.0"

reqtype="Код шаблону (Код із довTemplate code (code from ref.49): 'Інформація про реєстрацію платника податків' Taxpayer registration information' - 36"

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

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

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

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

<ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)" lname**Tax/Taxpayer Identification Number (INN-RNUKPN)/EDRPOU" 

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

fname                     fname="**Ім'яFirst name" 

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

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

</ident>

<!-- Параметри запиту Інформація про реєстрацію платника податків Query Parameters: Information on Taxpayer Registration -->

<additionaldata source="**Найменування реєстру для перевірки Name of the register for verification (fiskregistration - реєстр платників податківRegister of Taxpayers, edpod - реєстр платників єдиного податкуRegister of Single Taxpayers, bpartner - перевірка податкового боргуTax Debt Check)"/>

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

<!-- Блок trace містить метрики таймінгу кроків формування компонентів 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="Ознака безоплатності за типом запиту ‘Моніторинг клієнта організації’ (reqreason=1), код (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)"

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>

<!-- Інформація про реєстрацію платника податків Taxpayer registration information -->

<comp id="48" descr="Інформація про реєстрацію платника податківTaxpayer registration information">

<taxagent okpo="РНОКПП Taxpayer Identification Number (ІПНTIN) /ЄДРПОУ суб’єктаUSREOU"

found="Availability of taxpayer registration information, numeric value: -2/-1/0/1 - чисельне визначення факту реєстрації суб’єкта як платника податків"

foundref="Текстове визначення факту реєстрації суб’єкта як платника податків (Код із довAvailability of taxpayer registration information, text value (code from ref.58)"

source="Найменування джерела даних"Name of the data source, text value"

response="Відповідь АПІ у форматі jsonTaxpayer registration information in JSON format"/>

</comp>

</ubkidata>

Приклад

Example

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "9876543211"
							},
							"additionaldata": {
								"source": "fiskregistration"
							},
							"reqlng": "24"
						},
						"version": "1.0",
						"reqtype": "36",
						"reqreason": "2"
					},
					"descr": "Об`єктRequest запитуobject"
				},
				"descr": "КонвертRequest запитуenvelope"
			},
			"sessid": "4EC8D647B0DB4D9A862CDC25AB00000F"
		}
	}
}

Response JSON

Code Block
{
    "ubkidata": {
        "tech": {
            "trace": {
                "step": [
                    {
                        "name": "build report",
                        "stm": "2025-01-24 1113:1445:2050.673011",
                        "ftm": "2025-01-24 1113:1445:2050.981168"
                    }
                ]
            },
            "error": [],
            "reqinfo": {
                "reqid": "req2#000003432553req2#000003432928"
            }
        },
        "comp": [
            {
                "id": "48",
                "descr": "ІнформаціяTaxpayer про реєстрацію платника податківregistration information",
                "taxagent": {
                    "found": "1",
                    "foundref": "ЗнайденаFound інформаціяinformation",
                    "okpo": "98765432113233312110",
                    "source": "fiskregistrationbpartner",
                    "response": "[{\"registry_id\":\"registrationb-partner\",\"registry_name\":\"ДаніДізнайся більше про взяття на облік платників податківсвого бізнес-партнера\",\"updated_datetime\":\"2021-01-26 11:34:15.590\"null,\"messageshort_info\":\"Дані відсутні - зараз не оновлюються\",\"data\":{\"FULL_NAMEshort_info_color\":\"ІВАНОВ ІВАН ІВАНОВИЧgray\",\"TIN_Smessage\":null,\"ADRESSДані відсутні - зараз не оновлюються\":null,\"D_REG_STIdata\":\"19.01.2006\",\"N_REG_STI\":\"95-Ц\",\"C_STI_MAIN_NAME\":\"1229, ГОЛОВНЕ УПРАВЛІННЯ ДПС У ЛУГАНСЬКІЙ ОБЛАСТІ, СТАНИЧНО-ЛУГАНСЬКЕ УПРАВЛІННЯ, СТАНИЧНО-ЛУГАНСЬКА ДПІ(СТАНИЧНО-ЛУГАНСЬКИЙ РАЙОН)\",\"VED_LIC\":null,\"D_ZAKR_STI\":null}}]"
 null}]"
                    }
            }
        ]
    }
}

Request XML

Code Block
<doc>
   <ubki sessid="C1D901B26FFF4277B443FC432791A4B9">
      <req_envelope descr="КонвертRequest запитуobject">
         <req_xml descr="Об’єктRequest запитуenvelope">
            <request version="1.0" reqtype="36" reqreason="2" >
               <i reqlng="1">
                  <ident okpo="9876543211" />
                  <additionaldata source="fiskregistration" />
               </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="2025-01-24 1113:1247:5150.95136" ftm="2025-01-24 1113:1247:5250.384247"/>
        </trace>
        <reqinfo reqid="req2#000003432549req2#000003432929"/>
    </tech>
    <comp id="48" descr="Інформація про реєстрацію платника податківTaxpayer registration information">
        <taxagent found="1" foundref="ЗнайденаFound інформаціяinformation" okpo="98765432113233312110" source="fiskregistrationbpartner" response="[{&quot;registry_id&quot;:&quot;registration&quot;,&quot;registry_name&quot;:&quot;Дані про взяття на облік платників податків&quot;,&quot;updated_datetime="[{&quot;registry_id&quot;:&quot;2021-01-26 11:34:15.590b-partner&quot;,&quot;message&quot;:&quot;&quot;,&quot;data&quot;:{&quot;FULL_NAMEregistry_name&quot;:&quot;ІВАНОВ ІВАН ІВАНОВИЧДізнайся більше про свого бізнес-партнера&quot;,&quot;TINupdated_Sdatetime&quot;:null,&quot;ADRESS&quot;:null,&quot;D_REG_STIshort_info&quot;:&quot;19.01.2006Дані відсутні - зараз не оновлюються&quot;,&quot;Nshort_REGinfo_STIcolor&quot;:&quot;95-Цgray&quot;,&quot;C_STI_MAIN_NAMEquot;message&quot;:&quot;1229, ГОЛОВНЕ УПРАВЛІННЯ ДПС У ЛУГАНСЬКІЙ ОБЛАСТІ, СТАНИЧНО-ЛУГАНСЬКЕ УПРАВЛІННЯ, СТАНИЧНО-ЛУГАНСЬКА ДПІ(СТАНИЧНО-ЛУГАНСЬКИЙ РАЙОН)Дані відсутні - зараз не оновлюються&quot;,&quot;VED_LICdata&quot;:null,&quot;D_ZAKR_STI&quot;:null}}]"/>
    </comp>
</ubkidata>

...