Versions Compared

Key

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

...

Request params

*mandatory fields

<cki> (1) Identification of the individual

/legal entity 

for XML/"fo_cki" for JSON

Attribute 

Name 

Format

Number of a regular expression, individual (

дов

ref.51)

Number of a regular expression, legal entity (

дов

ref.51)

inn*

TIN of the credit history subject

[N,10] 10 numeric characters

37, 40

37, 40

person_id*

Unique identifier of a person (if the creditor has data, data transfer is mandatory)

[TEXT,~] variable length text format

-

-

is_gone*

Mark about the death of a person, where 0- alive, 1 - deceased (the field is mandatory for transfer)(code from the ref.56)

[N,10], numeric format

-

-

lname*

Last name

[TEXT,40] variable length text format, up to 40 characters

43

3

fname*

First name

[TEXT,40] variable length text format, up to 40 characters

43

-

mname*

Middle name

[TEXT,40] variable length text format, up to 40 characters

43

-

reqlng*

Search/transfer language (ref. 23)

[N,10] 10 numeric characters

2, 41

2, 41

reqlngref

Part presentation language, value (ref. 23)

[TEXT,250] variable length text format, up to 250 characters

bdate*

Date of birth

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

1

-

<ident> (1..*) Identification of the individual

/legal entity

vdate*

Дата інформації даного блоку

Date of the information from this part

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31дов

– day (01–31)

1

lng*

Мова надання блоку (Код із

Part presentation language (ref. 23)

[N,10],

числовий формат

numeric format

2, 41

lngref

inn

РНУКПН (ІПН) СКІ

Значення з довідника мови надання блоку (Значення із дов.23)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

inn

TIN of the credit history subject

[N,10] 10

чисельних символів.

numeric characters

37,40

lname*

Прізвище

Last name

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

43

fname*

Ім'я

First name

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

43

mname

По батькові

Middle name

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

43

bdate*

Дата народження

Date of birth

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31дов

– day (01–31)

1

csex*

Стать (Код із

Sex (code from ref. 1)

[N,10],

числовий формат

numeric format

4

csexref

family

Сімейний стан (Код із дов

Значення з довідника статі (Значення із дов.1)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

family

Marital status (code from ref. 2)

[N,10],

числовий формат

5

familyref

Значення з довідника сімейний стан (Значення із дов.2)

[TEXT,250] текстовий формат змінної довжини, до 250 символівдов

numeric format

5

ceduc

Освіта (Код із

Education (code from ref. 3)

[N,10],

числовий формат

6

ceducref

Значення з довідника освіти (Значення із дов.3)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

numeric format

6

cgrag

Громадянство (Код із дов.4

Citizenship (ISO 3166)

[TEXT,250]

текстовий формат змінної довжини, до 250 символів

8

cgragref

Значення з довідника громадянства (Значення із дов.4)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

spd

Наявність реєстрації СПД (Код із дов

variable length text format, up to 250 characters

8

spd

Presence of the business entity’s registration (code from ref. 5)

[N,10],

числовий формат

7

spdref

Значення з довідника наявність реєстрації СПД (Значення із дов.5)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

sstate

Соціальний статус (Код із дов

numeric format

7

sstate

Social status (code from ref. 6)

[N,10],

числовий формат

stateref

Значення з довідника соціальний статус (Значення із дов.6)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

cchild

Кількість дітей

numeric format

cchild

Number of children

[N,10],

числовий формат

numeric format

<work> (0..*) Block of information history of the place of work

vdate*

Дата інформації даного блоку

Date of the information from this part

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31дов

– day (01–31)

1

lng*

Мова надання блоку (Код із

Part presentation language (ref. 23)

[N,10],

числовий формат

numeric format

2,41

lngref

Значення з довідника мови надання блоку (Значення із дов.23)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

дов

cdolgn

Службове становище (Код із

Official position (code from ref. 8)

[N,10],

числовий формат

numeric format

9

cdolgnref

Значення з довідника службове становище (Значення із дов.8)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

wokpo

ЄДРПОУ місця роботи

wokpo

EDRPOU of the employer

[N,8] 8

чисельних символів

numeric characters

10

wname

Назва місця роботи оригінальною мовою

Name of the employer in the base language

[TEXT,250]

текстовий формат змінної довжини, до 250 символів

variable length text format, up to 250 characters

11

wstag

Стаж роботи, повних років

Length of service, years completed

[N,10],

числовий формат

numeric format

12

wdohod

Щомісячний дохід клієнта

Client’s monthly income

[N,15,2],

числовий формат з плаваючою точкою, 2 цифри після крапки

13

<urident> (1..*) Блок історії ідентифікації юрособи

okpo

ЄДРПОУ юр.особи

[N,10] 8,10 численних символів

10,40

vdate*

Дата інформації даного блоку

[YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

1

lng*

Мова надання блоку (Код із дов.23)

[N,10], числовий формат

2,41

lngref

Значення з довідника мови надання блоку (Значення із дов.23)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

urname*

Найменування юр.особи

[TEXT,250] текстовий формат змінної довжини, до 250 символів

3

urfrms

Форма власності (Код із дов.38)

[N,10], числовий формат

16

urfrmsref

Форма власності (Значення із дов.38)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

ureconom

Галузь економіки (Секція КВЕД2010) (Код із дов.36)

[TEXT,100] текстовий формат змінної довжини, до 100 символів

14

ureconomref

Галузь економіки (Секція КВЕД2010) (Значення із дов.36)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

urvide

Вид діяльності (КВЕД2010) (Код із дов.37)

[TEXT,100] текстовий формат змінної довжини, до 100 символів

15

urvideref

Вид діяльності (КВЕД2010) (Значення із дов.37)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

urdatreg

Дата реєстрації в ЄДР

[YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

1

urdatregnal

Дата реєстрації в податковій

[YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

1

<linked> (1..*) Блок пов'язаних осіб для юросіб (Директор, бухгалтер ...)

okpo2

РНУКПН (ІПН)/ЄДРПОУ пов'язаної особи

[N,10] 10 чисельних символів.

17

17

okpo2_name*

ПІБ/Найменування пов'язаної особи

[TEXT,250] текстовий формат змінної довжини, до 100 символів

3

3

linkrole*

Тип зв'язку (Код із дов.39)

[N,10] 10 чисельних символів.

18

18

linkroleref

Тип зв'язку (Значення із дов.39)

[TEXT,250] текстовий формат змінної довжини, до 100 символів

rdate*

Дата актуалізації зв'язку

[YYYY-MM-DD], YYYY - рік (1920 - 2099), MM - місяць (01 - 12), DD - день (01-31)

1

1

numeric format with a floating point, 2 digits after the point

13

<doc> (1..*)

Блок історії інформації документів

Document information history block

vdate*

Дата інформації даного блоку

Date of the information from this part

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31дов

– day (01–31)

1

1

lng*

Мова надання блоку (Код із

Part presentation language (ref. 23)

[N,10],

числовий формат

numeric format

2,41

2,41

lngref

Значення з довідника мови надання блоку (Значення із дов.23)

[TEXT,250] текстовий формат змінної довжини, до 250 символівдов

dtype*

Тип документа (Код із

Document type (code from ref. 7)

[N,10],

числовий формат

numeric format

44

44

dtyperef

dser

Серія документа

Значення з довідника тип документа (Значення із дов.7)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

dser

Document series

[TEXT,10]

текстовий формат змінної довжини, до 10 символів

variable length text format, up to 10 characters

20

20

dnom*

Номер документа

Document number

[TEXT,9]

текстовий формат змінної довжини, до 9 символів

variable length text format, up to 9 characters

42

2

eddr_number

Unique record number in the Unified State Demographic Register

[TEXT,~] variable length text format

dterm

Термін дії (обов'язкове для ID карт

Expiration date (mandatory for ID cards)

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31

– day (01–31)

dwho*

Ким виданий

Issuer

[TEXT,200]

текстовий формат змінної довжини, до 200 символів

variable length text format, up to 200 characters

21

21

dwdt*

Дата видачі документа

Document issue date

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31

– day (01–31)

1

1

<addr> (1..*) Address information history block

vdate*

Дата інформації даного блоку

Date of the information from this part

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31дов

– day (01–31)

1

1

lng*

Мова надання блоку (Код із

Part presentation language (ref. 23)

[N,10],

числовий формат

numeric format

2,41

2,41

lngref

Значення з довідника мови надання блоку (Значення із дов.23)

[TEXT,250] текстовий формат змінної довжини, до 250 символівдов

adtype*

Тип адреси (Код із

Address type (code from ref. 9)

[N,10],

числовий формат

numeric format

30

30

adtyperef

Значення з довідника тип адреси (Значення із дов.9

adcountry*

Country (Digital code from ISO 3166)

[TEXT,

250] текстовий формат змінної довжини, до 250 символів

adcountry*

Країна

[TEXT,40] текстовий формат змінної довжини, до 40 символів

40] variable length text format, up to 40 characters

22

22

adindex

Поштовий індекс

Postal code

[TEXT,20]

текстовий формат змінної довжини, до 20 символів

variable length text format, up to 20 characters

24

24

adstate

Область

Region

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

28

28

adarea

Район

District

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

29

29

adcity*

Населений пункт

Locality

[TEXT,40]

текстовий формат змінної довжини, до 40 символівдов

variable length text format, up to 40 characters

23

23

adcitytype

Тип населеного пункту (Код із

Locality type (code from ref. 22)

[N,10],

числовий формат

numeric format

9

9

adcitytyperef

Значення з довідника тип населеного пункту (Значення із дов.22)

[TEXT,250] текстовий формат змінної довжини, до 250 символів

adstreet*

Вулиця

Street

[TEXT,100]

текстовий формат змінної довжини, до 100 символів

variable length text format, up to 100 characters

27

27

adhome*

Будинок

House

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

22

22

adcorp

Корпус

Block

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

26

26

adflat

Квартира

Flat

[TEXT,40]

текстовий формат змінної довжини, до 40 символів

variable length text format, up to 40 characters

26

26

addrdirt

Адреса в одному рядку (буде виведений з експлуатації в наступних версіях АPІ, з

Address in one row (will not be used in subsequent API versions, the field is deemed invalid starting from 13.11.2019

поле вважається неприпустимим

)

[TEXT,1000]

текстовий формат змінної довжини, до 1000 символів

variable length text format, up to 1000 characters

25

25

<foto> (0..*)

vdate

Дата верифікації даних кредитором

Date of the information from this part

[YYYY-MM-DD], YYYY

- рік (1920 - 2099

– year (1920–2099), MM

- місяць (01 - 12

– month (01–12), DD

- день (01-31

– day (01–31)

inn

РНОКПП (ІПН) СКІ

TIN of the credit history subject

[N,10] 10

чисельних символів

numeric characters

foto

base64(

Фото

Photo)

[TEXT,~]

текстовий формат змінної довжиниперетвориться в картинку

variable length text format

converted into a picture