Функции для работы с физ. и юр. лицами

Модуль: person

Физическое лицо

Создать анкету физического лица

Для заключения договора и дальнейшей работы требуется создать физическое или юридическое лицо. Для физического лица необходимо указать: имя, номер телефона с функцией приёма SMS.

Функция: create_fl_person

Пример GET запроса:

https://api.codeblast.ru/person/create_fl_person?account_name=demo@mail.ru
                                                &account_password=demopass
                                                &fl_person_name=Андрей
                                                &fl_person_surname=Морозов
                                                &fl_person_patronymic=Иванович
                                                &fl_person_passport_series=0412
                                                &fl_person_passport_number=273618
                                                &fl_person_passport_who_issued=ОВД г. Ростов
                                                &fl_person_passport_when_issued=10.11.2005
                                                &fl_person_passport_date_birth=28.10.1985
                                                &fl_person_post_country=Россия
                                                &fl_person_post_postcode=192234
                                                &fl_person_post_city=Санкт-Петербург
                                                &fl_person_post_address=ул. Кутузовская д.35 кв.7
                                                &fl_person_contact_phone=+79043035678

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
account_name string имя учётной записи
account_password string пароль учётной записи
fl_person_name string физическое лицо: имя
fl_person_surname string физическое лицо: фамилия
fl_person_patronymic string физическое лицо: отчество
fl_person_passport_series string паспортные данные: серия
fl_person_passport_number string паспортные данные: номер
fl_person_passport_who_issued string паспортные данные: кем выдан
fl_person_passport_when_issued string паспортные данные: когда выдан
fl_person_passport_date_birth string паспортные данные: дата рождения
fl_person_post_country string почтовый адрес: страна
fl_person_post_postcode string почтовый адрес: индекс
fl_person_post_city string почтовый адрес: город
fl_person_post_address string почтовый адрес: адрес
fl_person_contact_phone string номер контактного телефона

Поля ответа:

Поле Тип Описание
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_ACCOUNT_NAME ошибка ввода имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
REG_ACCOUNT_PASSWORD ошибка ввода пароля учётной записи
".{6,48}"
REG_FL_PERSON_NAME ошибка ввода имени физического лица
".{2,64}"
REG_FL_PERSON_SURNAME ошибка ввода фамилии физического лица
".{2,64}"
REG_FL_PERSON_PATRONYMIC ошибка ввода отчества физического лица
".{2,64}"
REG_FL_PERSON_PASSPORT_SERIES ошибка ввода имени физического лица
"\d{4}"
REG_FL_PERSON_PASSPORT_NUMBER ошибка ввода фамилии физического лица
"\d{6}"
REG_FL_PERSON_PASSPORT_WHO_ISSUED ошибка ввода отчества физического лица
".{2,255}"
REG_FL_PERSON_PASSPORT_WHEN_ISSUED ошибка ввода имени физического лица
"\d{2}\.\d{2}\.\d{4}"
REG_FL_PERSON_PASSPORT_DATE_BIRTH ошибка ввода фамилии физического лица
"\d{2}\.\d{2}\.\d{4}"
REG_FL_PERSON_POST_COUNTRY ошибка ввода почтового адреса: страна
".{2,64}"
REG_FL_PERSON_POST_POSTCODE ошибка ввода почтового адреса: индекс
"\d{2,64}"
REG_FL_PERSON_POST_CITY ошибка ввода почтового адреса: город
".{2,255}"
REG_FL_PERSON_POST_ADDRESS ошибка ввода почтового адреса: адрес
".{2,255}"
REG_FL_PERSON_CONTACT_PHONE ошибка ввода номера контактного телефона
"[0-9\+]{1}[0-9]{2,64}"
AUTHORIZATION_FAIL ошибка авторизации
ACCEPT_NOT_EXISTS договор не заключён
PERSON_EXISTS анкета клиента уже существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Изменить анкену физического лица

Если Ваши персональные данные изменились, то Вы можете внести эти изменения.

Функция: change_fl_person

Пример GET запроса:

https://api.codeblast.ru/person/change_fl_person?token_data=data:string
                                                &fl_person_name=Андрей
                                                &fl_person_surname=Морозов
                                                &fl_person_patronymic=Иванович
                                                &fl_person_passport_series=0412
                                                &fl_person_passport_number=273618
                                                &fl_person_passport_who_issued=ОВД г. Ростов
                                                &fl_person_passport_when_issued=10.11.2005
                                                &fl_person_passport_date_birth=28.10.1985
                                                &fl_person_post_country=Россия
                                                &fl_person_post_postcode=192234
                                                &fl_person_post_city=Санкт-Петербург
                                                &fl_person_post_address=ул. Кутузовская д.35 кв.7
                                                &fl_person_contact_phone=+79043035678

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен
fl_person_name string физическое лицо: имя
fl_person_surname string физическое лицо: фамилия
fl_person_patronymic string физическое лицо: отчество
fl_person_passport_series string паспортные данные: серия
fl_person_passport_number string паспортные данные: номер
fl_person_passport_who_issued string паспортные данные: кем выдан
fl_person_passport_when_issued string паспортные данные: когда выдан
fl_person_passport_date_birth string паспортные данные: дата рождения
fl_person_post_country string почтовый адрес: страна
fl_person_post_postcode string почтовый адрес: индекс
fl_person_post_city string почтовый адрес: город
fl_person_post_address string почтовый адрес: адрес
fl_person_contact_phone string номер контактного телефона

Поля ответа:

Поле Тип Описание
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_FL_PERSON_NAME ошибка ввода имени физического лица
".{2,64}"
REG_FL_PERSON_SURNAME ошибка ввода фамилии физического лица
".{2,64}"
REG_FL_PERSON_PATRONYMIC ошибка ввода отчества физического лица
".{2,64}"
REG_FL_PERSON_PASSPORT_SERIES ошибка ввода имени физического лица
"\d{4}"
REG_FL_PERSON_PASSPORT_NUMBER ошибка ввода фамилии физического лица
"\d{6}"
REG_FL_PERSON_PASSPORT_WHO_ISSUED ошибка ввода отчества физического лица
".{2,255}"
REG_FL_PERSON_PASSPORT_WHEN_ISSUED ошибка ввода имени физического лица
"\d{2}\.\d{2}\.\d{4}"
REG_FL_PERSON_PASSPORT_DATE_BIRTH ошибка ввода фамилии физического лица
"\d{2}\.\d{2}\.\d{4}"
REG_FL_PERSON_POST_COUNTRY ошибка ввода почтового адреса: страна
".{2,64}"
REG_FL_PERSON_POST_POSTCODE ошибка ввода почтового адреса: индекс
"\d{2,64}"
REG_FL_PERSON_POST_CITY ошибка ввода почтового адреса: город
".{2,255}"
REG_FL_PERSON_POST_ADDRESS ошибка ввода почтового адреса: адрес
".{2,255}"
REG_FL_PERSON_CONTACT_PHONE ошибка ввода номера контактного телефона
"[0-9\+]{1}[0-9]{2,64}"
AUTHORIZATION_FAIL ошибка авторизации
PERSON_EXISTS анкета клиента уже существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать анкету физического лица

Эта функция предоставит персональные данные физического лица.

Функция: show_fl_person

Пример GET запроса:

https://api.codeblast.ru/person/show_fl_person?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <fl_person_name>Андрей</fl_person_name>
    <fl_person_surname>Морозов</fl_person_surname>
    <fl_person_patronymic>Иванович</fl_person_patronymic>
    <fl_person_passport_series>0412</fl_person_passport_series>
    <fl_person_passport_number>273618</fl_person_passport_number>
    <fl_person_passport_who_issued>ОВД г. Ростов</fl_person_passport_who_issued>
    <fl_person_passport_when_issued>10.11.2005</fl_person_passport_when_issued>
    <fl_person_passport_date_birth>28.10.1985</fl_person_passport_date_birth>
    <fl_person_post_country>Россия</fl_person_post_country>
    <fl_person_post_postcode>192234</fl_person_post_postcode>
    <fl_person_post_city>Санкт-Петербург</fl_person_post_city>
    <fl_person_post_address>ул. Кутузовская д.35 кв.7</fl_person_post_address>
    <fl_person_contact_phone>+79043035678</fl_person_contact_phone>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "fl_person_name": "Андрей",
  "fl_person_surname": "Морозов",
  "fl_person_patronymic": "Иванович",
  "fl_person_passport_series": "0412",
  "fl_person_passport_number": "273618",
  "fl_person_passport_who_issued": "ОВД г. Ростов",
  "fl_person_passport_when_issued": "10.11.2005",
  "fl_person_passport_date_birth": "28.10.1985",
  "fl_person_post_country": "Россия",
  "fl_person_post_postcode": "192234",
  "fl_person_post_city": "Санкт-Петербург",
  "fl_person_post_address": "ул. Кутузовская д.35 кв.7",
  "fl_person_contact_phone": "+79043035678",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
fl_person_name string физическое лицо: имя
fl_person_surname string физическое лицо: фамилия
fl_person_patronymic string физическое лицо: отчество
fl_person_passport_series string паспортные данные: серия
fl_person_passport_number string паспортные данные: номер
fl_person_passport_who_issued string паспортные данные: кем выдан
fl_person_passport_when_issued string паспортные данные: когда выдан
fl_person_passport_date_birth string паспортные данные: дата рождения
fl_person_post_country string почтовый адрес: страна
fl_person_post_postcode string почтовый адрес: индекс
fl_person_post_city string почтовый адрес: горо
fl_person_post_address string почтовый адрес: адрес
fl_person_contact_phone string номер контактного телефона
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
PERSON_NOT_EXISTS анкеты клиента не существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Идентификация лица

Получить тип лица

Функция позволяет определить к какому типу относится учётная запись клиента (физическое лицо, юридическое лицо, индивидуальный предприниматель).

Функция: get_person_type

Пример GET запроса:

https://api.codeblast.ru/person/get_person_type?token_data=data:string

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <person_type>FL_PERSON</person_type>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "person_type": "FL_PERSON",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
person_type string тип персоны «FL_PERSON, UL_PERSON, IP_PERSON»
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
PERSON_EXISTS анкета клиента уже существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет