Объекты профиля

Получить данные профиля

GET /(company_code)/v2/aol/profile/(profile_code)

Получить данные профиля

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код запрашиваемого профиля. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Объект данных профиля. Включаемые поля зависят от роли авторизованного пользователя.
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

Подробнее см. Коды ошибок.

Обновить данные профиля

PUT /(company_code)/v2/aol/profile/(profile_code)

Обновить данные профиля

Все поля данных в JSON запроса необязательны, любое поле может быть опущено, если его данные не изменились. В зависимости от ролей авторизованного пользователя и обновляемого профиля, доступна для обновления может быть только часть полей данных. Значения ограниченных полей в JSON запроса будут игнорированы.

Если профиль приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • nickname (string/null) – (Необязательно) Приветственное имя
  • name (string/null) – (Необязательно) ФИО полностью / полное наименование юр. лица
  • shortname (string/null) – (Необязательно) Фамилия Имя / краткое наименование юр. лица
  • fname (string/null) – (Необязательно) Имя
  • mname (string/null) – (Необязательно) Отчество / среднее имя
  • lname (string/null) – (Необязательно) Фамилия
  • date_of_birth (string/null) – (Необязательно) Дата рождения в формате ISO: YYYY-MM-DD
  • sex (string/null) – (Необязательно) Пол, код согласно таблице подстановки
  • secondary_phone (string/null) – (Необязательно) Дополнительный номер телефона
  • secondary_email (string/null) – (Необязательно) Дополнительный адрес email
  • subscriptions (integer) – (Необязательно) Битовая маска настроек подписки на уведомления
  • do_not_disturb_from (string/null) – (Необязательно) Время «не беспокоить с» в формате ISO: HH:MM:SS
  • do_not_disturb_to (string/null) – (Необязательно) Время «не беспокоить по» в формате ISO: HH:MM:SS
  • contact_tz (string/null) – (Необязательно) Часовой пояс профиля, код согласно таблице подстановки
  • attributes (array) – (Необязательно) Объекты данных атрибутов профиля (см. ниже)
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных профиля

Поля данных атрибута в запросе

У каждого объекта в массиве запроса attributes есть следующие поля:

Имя поля Тип Описание
seq integer Последовательный номер атрибута, от 1 до 20
value string Новое значение атрибута

Последовательные номера атрибутов должны быть теми же, что в объектах атрибутов, возвращаемыми API в данных профиля.

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

Подробнее см. Коды ошибок.

Получить данные адреса

GET /(company_code)/v2/aol/profile/(profile_code)/address/(int: address_id)

Получить данные адреса профиля

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля с запрашиваемым адресом. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • address_id – Идентификатор запрашиваемого адреса
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных адреса профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

Подробнее см. Коды ошибок.

Обновить данные адреса

PUT /(company_code)/v2/aol/profile/(profile_code)/address/(int: address_id)

Обновить данные адреса профиля

Если профиль приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • address_id – Идентификатор обновляемого адреса
JSON-объект запроса:
 
  • country (string/null) – Идентификатор страны, код ISO alpha-2 согласно таблице подстановки
  • postal_code (string/null) – Почтовый индекс
  • address_line1 (string/null) – Строка адреса 1
  • address_line2 (string/null) – Строка адреса 2
  • address_line3 (string/null) – Строка адреса 3
  • address_line4 (string/null) – Строка адреса 4
  • region_code (string/null) – Код региона
  • region_type (string/null) – Тип региона (сокращенный)
  • region_type_full (string/null) – Тип региона
  • region (string/null) – Регион
  • area_code (string/null) – Код района
  • area_type (string/null) – Тип района (сокращенный)
  • area_type_full (string/null) – Тип района
  • area (string/null) – Район
  • city_code (string/null) – Код города
  • city_type (string/null) – Тип города (сокращенный)
  • city_type_full (string/null) – Тип города
  • city (string/null) – Город
  • settlement_code (string/null) – Код населенного пункта
  • settlement_type (string/null) – Тип населенного пункта (сокращенный)
  • settlement_type_full (string/null) – Тип населенного пункта
  • settlement (string/null) – Населенный пункт
  • street_code (string/null) – Код улицы
  • street_type (string/null) – Тип улицы (сокращенный)
  • street_type_full (string/null) – Тип улицы
  • street (string/null) – Улица
  • house_code (string/null) – Код дома
  • house_type (string/null) – Тип дома (сокращенный)
  • house_type_full (string/null) – Тип дома
  • house (string/null) – Дом
  • block_type (string/null) – Тип корпуса/строения (сокращенный)
  • block_type_full (string/null) – Тип корпуса/строения
  • block (string/null) – Корпус/строение
  • flat_type (string/null) – Тип квартиры (сокращенный)
  • flat_type_full (string/null) – Тип квартиры
  • flat (string/null) – Квартира
  • military_unit (string/null) – Воинская часть
  • postal_box (string/null) – Абонентский ящик
  • external_id (string/null) – Идентификатор во внешней системе
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных обновленного адреса профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed
  • object.id.notfound

Подробнее см. Коды ошибок.

Получить данные документа

GET /(company_code)/v2/aol/profile/(profile_code)/identifier/(int: identifier_id)

Получить данные документа профиля

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля с запрашиваемым документом. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • identifier_id – Идентификатор запрашиваемого документа
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных документа профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

Подробнее см. Коды ошибок.

Обновить данные документа

PUT /(company_code)/v2/aol/profile/(profile_code)/identifier/(int: identifier_id)

Обновить данные документа профиля

Если профиль приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • identifier_id – Идентификатор обновляемого документа
JSON-объект запроса:
 
  • identifier_type (string/null) – Код типа документа согласно таблице подстановки
  • identifier_sr (string/null) – Серия документа
  • identifier_nr (string/null) – Номер документа
  • country (string/null) – Идентификатор страны, код ISO alpha-2 согласно таблице подстановки
  • date_of_issue (date/null) – Дата выдачи в формате ISO: YYYY-MM-DD
  • date_of_expiration (date/null) – Дата окончания срока действия в формате ISO: YYYY-MM-DD
  • authority (string/null) – Орган, выдавший документ
  • authority_code (string/null) – Код органа, выдавшего документ
  • fname (string/null) – Имя
  • mname (string/null) – Отчество / среднее имя
  • lname (string/null) – Фамилия
  • sex (string/null) – Пол, код согласно таблице подстановки
  • date_of_birth (date/null) – Дата рождения в формате ISO: YYYY-MM-DD
  • place_of_birth (string/null) – Место рождения
  • nationality (string/null) – Гражданство
  • endorsement (string/null) – Особые отметки
  • external_id (string/null) – Идентификатор во внешней системе
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных обновленного документа профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • request.validation.failed
  • object.id.notfound

Подробнее см. Коды ошибок.

Задать контрольный вопрос

POST /(company_code)/v2/aol/profile/(profile_code)/controlquestion

Задать контрольный вопрос и ответ для восстановления доступа

Доступно только для собственного профиля авторизованного пользователя и если для клиентского приложения настроена схема многофакторной аутентификации SMS.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • control_question (string) – Новый контрольный вопрос
  • control_answer (string) – Новый правильный ответ на контрольный вопрос
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • request.validation.failed
  • auth.restricted

Подробнее см. Коды ошибок.

Сгенерировать резервные коды

POST /(company_code)/v2/aol/profile/(profile_code)/backupcodes

Сгенерировать новые резервные коды

Генерирует и возвращает новый набор из десяти одноразовых резервных кодов безопасности. Доступно только для собственного профиля авторизованного пользователя и если для клиентского приложения настроена схема многофакторной аутентификации SMS.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (array) – Массив из десяти сгенерированных резервных кодов в виде строк

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted

Подробнее см. Коды ошибок.

Установить или изменить пароль

POST /(company_code)/v2/aol/profile/(profile_code)/password

Установить или изменить пароль профиля

Пользователи могут изменять пароль своих собственных профилей. Если ранее для профиля пользователя не был задан пароль, поле запроса old_password не проверяется и может быть пустой строкой. Иначе оно должно содержать верный текущий пароль пользователя. При неверном старом пароле возвращается код ошибки auth.password.invalid.

Если качество переданного нового пароля слишком низкое, возвращает код ошибки request.validation.failed со статусом HTTP 422.

On successful password set or change, current session token will be invalidated and a new one issued.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • old_password (string/null) – (Необязательно) Старый пароль пользователя для проверки
  • new_password (string) – Новый пароль профиля
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • session_token (string) – Сессионный токен пользователя
  • session_state (string) – Состояние сессии пользователя: authorized. См. Пользовательские сессии
  • profile_mnemocode (string) – Мнемокод профиля пользователя

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.password.invalid
  • request.validation.failed
  • auth.restricted

Подробнее см. Коды ошибок.

Включить/отключить многофакторную аутентификацию с OTP

POST /(company_code)/v2/aol/profile/(profile_code)/otpenabled

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

Многофакторная аутентификация может быть включена или отключена для клиентского приложения.

OTP не может быть включен или выключен для пользователей приложения с отключенной многофакторной аутентификацией.

Для включения или отключения OTP у профиля должен быть установлен основной номер телефона, а пользователь должен предоставить код подтверждения, высланный на его номер телефона.

Доступно только для собственного профиля авторизованного пользователя. Для подтверждения включения или отключения OTP клиентскому приложению нужно далее использовать вызов otpenabled/confirm в течение срока хранения в платформе данных о запросе otpenabled.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • otp_enabled_flag (boolean) – Включить или отключить многофакторную аутентификацию
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • request.validation.failed

Подробнее см. Коды ошибок.

Подтвердить включение/отключение многофакторной аутентификации с OTP

POST /(company_code)/v2/aol/profile/(profile_code)/otpenabled/confirm

Подтвердить включение или отключение многофакторной аутентификации с одноразовым паролем

Клиентское приложение начинает процесс, используя вызов otpenabled.

Для подтверждения включения или отключения многофакторной аутентификации пользователь должен ввести одноразовый пароль (код), полученный в SMS. Клиентское приложение передает этот код в поле запроса otp.

Доступно только для собственного профиля авторизованного пользователя.

При возврате auth.otp.invalid клиентское приложение должно начать процесс заново, используя вызов otpenabled.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • otp (string) – (Необязательно) Введенный пользователем одноразовый код
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных обновленного профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • auth.otp.invalid
  • request.validation.failed

Подробнее см. Коды ошибок.

Изменить основной email

POST /(company_code)/v2/aol/profile/(profile_code)/primaryemail

Изменить основной адрес электронной почты

Пользователь с достаточными правами доступа может изменить основной адрес email для профиля другого пользователя. В таком случае не производится проверка адреса email и профиль обновляется сразу. Возвращаются данные обновленного профиля, а поле ответа verification содержит NONE.

Пользователи могут изменять основной адрес email собственных профилей. В этом случае на email пользователя отправляется сообщение для подтверждения. Данные профиля не возвращаются, а поле ответа verification содержит LINK. Клиентскому приложению далее следует использовать вызов primaryemail/confirm в течение срока действия ссылки подтверждения.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • primary_email (string) – Новый основной адрес email
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • verification (string) – Тип требуемой проверки: LINK или NONE
  • data (object) – (Необязательно) Если verification содержит NONE: Объект данных обновленного профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • profile.identifier.used
  • profile.identifier.invalid
  • request.validation.failed

Подробнее см. Коды ошибок.

Подтвердить смену основного email

POST /(company_code)/v2/aol/profile/primaryemail/confirm

Подтвердить смену основного адреса электронной почты

Этот вызов проверяет ссылку подтверждения, отправленную на адрес email пользователя вызовом primaryemail. Профиль пользователя, запрашивающего смену основного адреса email, определяется из токена подтверждения в поле запроса token. Сессионный токен в заголовке Authorization не требуется, так что ссылка подтверждения может быть открыта на любом устройстве.

Если переданный адрес email уже использован, возвращается код ошибки profile.identifier.used.

Если токен из ссылки действителен и новый адрес email допустим, у профиля пользователя меняется основной адрес email. Этот вызов не авторизует пользователя, сессионный токен или данные обновленного профиля не возвращаются.

JSON-объект запроса:
 
  • token (string) – Токен подтверждения из ссылки, отправленной на email
  • captcha_response (string) – Ответный токен captcha пользователя в виде, предоставленном Recaptcha
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.token.expired
  • auth.token.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.captcha.invalid
  • object.id.notfound
  • auth.restricted
  • profile.identifier.used
  • profile.identifier.invalid
  • request.validation.failed

Подробнее см. Коды ошибок.

Изменить основной телефон

POST /(company_code)/v2/aol/profile/(profile_code)/primaryphone

Изменть основной номер телефона

Пользователь с достаточными правами доступа может изменить основной номер телефона для профиля другого пользователя. В таком случае не производится проверка номера телефона и профиль обновляется сразу. Возвращаются данные обновленного профиля, а поле ответа verification содержит NONE.

Пользователи могут изменять основной номер телефона собственных профилей. В этом случае на телефон пользователя отправляется одноразовый код подтверждения. Данные профиля не возвращаются, а поле ответа verification содержит SMS. Для завершения смены основного номера телефона клиентскому приложению далее следует использовать вызов primaryphone/confirm в течение срока действия кода.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • primary_phone (string) – Новый основной номер телефона
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • verification (string) – Тип требуемой проверки: SMS или NONE
  • data (object) – (Необязательно) Если verification содержит NONE: Объект данных обновленного профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.restricted
  • profile.identifier.used
  • request.validation.failed

Подробнее см. Коды ошибок.

Подтвердить смену основного телефона

POST /(company_code)/v2/aol/profile/(profile_code)/primaryphone/confirm

Подтвердить смену основного номера телефона

После возврата вызовом primaryphone поля verification, содержащего SMS, клиентскому приложению нужно использовать этот вызов, передавая введенный пользователем одноразовый код (OTP) подтверждения.

Доступно только для собственного профиля авторизованного пользователя.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • otp (string) – Введенный пользователем код (OTP) подтверждения
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных обновленного профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • auth.otp.invalid
  • profile.identifier.used
  • request.validation.failed

Подробнее см. Коды ошибок.

Установить идентификатор пользователя OAuth

POST /(company_code)/v2/aol/profile/(profile_code)/oauthid

Установить идентификатор пользователя OAuth для аутентификации

Проверяет код авторизации пользователя OAuth в одном из настроенных провайдеров OAuth и сохраняет идентификатор пользователя OAuth для аутентификации через указанного провайдера OAuth.

Если успешно проверенный идентификатор пользователя OAuth уже используется для другого профиля, возвращается код ошибки profile.identifier.used.

Если в качестве кода OAuth (code) передается null, идентификатор пользователя OAuth очищается. В этом случае проверка OAuth не производится.

Доступно только для собственного профиля авторизованного пользователя.

Заголовки запроса:
 
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • provider_id (integer) – Идентификатор провайдера OAuth, должен быть от 1 до 5
  • code (string/null) – Код OAuth в виде, полученном от провайдера OAuth, либо null для очистки идентификатора пользователя OAuth
  • redirect_uri (string/null) – URI перенаправления в виде, переданном в провайдер OAuth, либо null для очистки идентификатора пользователя OAuth
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Обновленный объект данных профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • object.id.notfound
  • auth.oauth.failed
  • profile.identifier.used
  • request.validation.failed
  • auth.restricted

Подробнее см. Коды ошибок.

Закрыть профиль

POST /(company_code)/v2/aol/profile/(profile_code)/close

Установить статус «профиль закрыт»

На этот вызов влияет конфигурация аутентификации для критических изменений.

Если вызвано для собственного профиля и профиля приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • password (string) – (Необязательно) Пароль авторизованного пользователя для аутентификации для критических изменений
  • otp (string) – (Необязательно) Одноразовый код (OTP) из SMS для аутентификации для критических изменений
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Обновленный объект данных профиля
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • critical_auth_method (string) – (Необязятельно) Если error_code содержит critical.auth.required: Требуемое поле запроса с аутентификацией для критических изменений: password или otp

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • critical.auth.required
  • auth.password.invalid
  • auth.otp.invalid
  • object.id.notfound

Подробнее см. Коды ошибок.

Обновить статус «заблокировано»

POST /(company_code)/v2/aol/profile/locked

Обновить статус «профиль заблокирован»

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект запроса:
 
  • profile_codes (array) – Коды профилей для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • is_locked (boolean) – Новое состояние флага «профиль заблокирован»
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (array) – Объекты результата операции

Поля результата операции

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
profile_code string Код профиля из запроса
status string Статус операции, success или error
error_code string (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
data object Обновленный объект данных профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

Подробнее см. Коды ошибок.

Требовать сброс пароля

POST /(company_code)/v2/aol/profile/passwordreset

Установить статус «требуется сброс пароля»

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект запроса:
 
  • profile_codes (array) – Коды профилей для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (array) – Объекты результата операции

Поля результата операции

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
profile_code string Код профиля из запроса
status string Статус операции, success или error
error_code string (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

Подробнее см. Коды ошибок.

Установить статус «остановлено»

POST /(company_code)/v2/aol/profile/stop

Установить статус «профиль остановлен»

На этот вызов влияет конфигурация аутентификации для критических изменений.

Если профиль приостановлен, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект запроса:
 
  • profile_codes (array) – Коды профилей для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
  • password (string) – (Необязательно) Пароль авторизованного пользователя для аутентификации для критических изменений
  • otp (string) – (Необязательно) Одноразовый код (OTP) из SMS для аутентификации для критических изменений
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • critical_auth_method (string) – (Необязятельно) Если error_code содержит critical.auth.required: Требуемое поле запроса с аутентификацией для критических изменений: password или otp
  • data (array) – Объекты результата операции

Поля результата операции

У каждого объекта в массиве ответа data есть следующие поля:

Имя поля Тип Описание
profile_code string Код профиля из запроса
status string Статус операции, success или error
error_code string (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
data object Обновленный объект данных профиля

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • critical.auth.required
  • auth.password.invalid
  • auth.otp.invalid
  • object.id.notfound

Подробнее см. Коды ошибок.

Перечислить экземпляры

GET /(company_code)/v2/aol/profile/(profile_code)/entry

Получить данные экземпляров профиля

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код запрашиваемого профиля. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
URL-параметры запроса:
 
  • status (string) – (Необязательно) Код статуса экземпляра, по которому фильтровать результаты, либо список кодов, разделенных запятыми
  • product_class (string) – (Необязательно) Код класса продукта, по которому фильтровать результаты, либо список кодов, разделенных запятыми
  • entry_class (string) – (Необязательно) Код класса экземпляра, по которому фильтровать результаты, либо список кодов, разделенных запятыми
JSON-объект ответа:
 
  • status (string) – success или error
  • data (array) – Объекты данных экземпляра. Включаемые поля зависят от роли авторизованного пользователя.
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound
  • request.validation.failed

Подробнее см. Коды ошибок.

Зачислить экземпляр

POST /(company_code)/v2/aol/profile/(profile_code)/entry

Зачислить новый экземпляр для профиля

Этот вызов используется для зачисления (создания) экземпляра, представляющего банковскую карту, бонусный счет, счет кэшбэка и т.п., которые уже есть у клиента.

Если передан неверный класс экземпляров, возвращает код ошибки request.validation.failed. Если экземпляр с переданным внешним идентификатором уже существует, возвращает код ошибки auth.restricted.

Если флаг «остановлено» профиля экземпляра содержит true, возвращает код ошибки auth.restricted.

Если статус продукта или статус основного продукта приложения равен S или C, возвращает код ошибки auth.restricted.

Если пользователь должен принять юридические соглашения для зачисления экземпляра указанного класса экземпляров, массив запроса accept_disclaimers должен содержать коды всех требуемых соглашений для успешного выполнения этого вызова. Иначе возвращается код ошибки auth.disclaimer.invalid.

Если класс экземпляров настроен для зачисления экземпляра с использованием OAuth, пользователи с ролью CLIENT должны передавать поля запроса oauth_code и oauth_redirect_uri вместо полей данных экземпляра. Выполняется проверка OAuth, и данные экземпляра получаются от провайдера OAuth.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • entry_class (string) – Название класса экземпляров для нового экземпляра
  • external_id (string) – (Необязательно) Идентификатор во внешней системе для нового экземпляра
  • entry_nr (string/null) – (Необязательно) Номер экземпляра
  • entry_date (string) – (Необязательно) Дата вступления в силу экземпляра
  • name (string/null) – (Необязательно) Название экземпляра для отображения
  • details (string/null) – (Необязательно) Текст описания экземпляра
  • attributes (array) – (Необязательно) Объекты данных атрибутов экземпляра (см. ниже)
  • accept_disclaimers (array) – (Необязательно) Массив строковых кодов соглашений, принятых пользователем
  • oauth_code (string) – (Необязательно) Код OAuth в виде, полученном от провайдера OAuth
  • oauth_redirect_uri (string) – (Необязательно) URI перенаправления в виде, переданном провайдеру OAuth
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных созданного экземпляра

Поля данных атрибута в запросе

У каждого объекта в массиве запроса attributes есть следующие поля:

Имя поля Тип Описание
seq integer Последовательный номер атрибута, от 1 до 20
value string Новое значение атрибута

Последовательные номера атрибутов должны быть теми же, что в объектах атрибутов, возвращаемыми API в данных экземпляра.

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.oauth.failed
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • auth.disclaimer.invalid
  • object.id.notfound
  • request.validation.failed

Подробнее см. Коды ошибок.

Зарегистрироваться для экземпляра

POST /(company_code)/v2/aol/profile/(profile_code)/entry/signup

Зарегистрироваться для нового экземпляра для профиля

Этот вызов используется для регистрации для экземпляра, представляющего новый бонусный счет, счет кэшбэка и т.п., которого еще нет у клиента.

Если передан неверный класс экземпляров, возвращает код ошибки request.validation.failed.

Если профиль приостановлен, возвращает код ошибки auth.restricted.

Если статус продукта или статус основного продукта приложения равен S или C, возвращает код ошибки auth.restricted.

Если пользователь должен принять юридические соглашения, чтобы зарегистрироваться для экземпляра указанного класса экземпляров, массив запроса accept_disclaimers должен содержать коды всех требуемых соглашений для успешного выполнения этого вызова. Иначе возвращается код ошибки auth.disclaimer.invalid.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код профиля для обновления. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект запроса:
 
  • entry_class (string) – Название класса экземпляров для нового экземпляра
  • accept_disclaimers (array) – (Необязательно) Массив строковых кодов соглашений, принятых пользователем
JSON-объект ответа:
 
  • status (string) – success или error
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки
  • data (object) – Объект данных созданного экземпляра

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • auth.disclaimer.invalid
  • object.id.notfound
  • request.validation.failed

Подробнее см. Коды ошибок.

Создать профиль

POST /(company_code)/v2/aol/profile

Создать новый профиль CLIENT

Этот вызов позволяет авторизованным пользователям с ролью PARTNER создавать новые профили с ролью CLIENT. В зависимости от роли создаваемого профиля должно быть передано значение primary_phone либо primary_email, которое станет основным идентификатором нового профиля.

Если какое-либо из переданных значений полей данных (объект data) не проходит валидацию, все поля данных будут проигнорированы.

Если статус основного продукта приложения равен S или C, возвращает код ошибки auth.restricted.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
JSON-объект запроса:
 
  • primary_phone (string/null) – (Необязательно) Основной номер телефона для нового профиля
  • primary_email (string/null) – (Необязательно) Основной адрес email для нового профиля
  • data (object) – (Необязательно) Поля данных для нового профиля (см. ниже)
JSON-объект ответа:
 
  • status (string) – success или error
  • data (object) – Объект данных созданного профиля
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Поля данных профиля

Если он включен в запрос, объект data может содержать следующие необязательные поля:

Имя поля Тип Допускает null Описание
nickname string Да Приветственное имя
name string Да ФИО полностью / полное наименование юр. лица
shortname string Да Фамилия Имя / краткое наименование юр. лица
fname string Да Имя
mname string Да Отчество / среднее имя
lname string Да Фамилия
date_of_birth string Да Дата рождения в формате ISO: YYYY-MM-DD
sex string Да Пол, код согласно таблице подстановки
subscriptions integer Нет Битовая маска настроек подписки на уведомления
do_not_disturb_from string Да Время «не беспокоить с» в формате ISO: HH:MM:SS
do_not_disturb_to string Да Время «не беспокоить по» в формате ISO: HH:MM:SS
contact_tz string Да Часовой пояс профиля, код согласно таблице подстановки
attributes array Да Объекты данных атрибутов профиля (см. ниже)
external_id string Да Внешний идентификатор профиля

Клиентскому приложению следует включать только те поля данных, для которых у него есть данные. Избегайте значений null для незадействованных полей, так как это может привести к перезаписи значений по умолчанию, генерируемых при создании профиля.

Поля данных атрибута

У каждого объекта из массива attributes в объекте данных профиля в запросе есть следующие поля:

Имя поля Тип Описание
seq integer Последовательный номер атрибута, от 1 до 10
value string Новое значение атрибута

Последовательные номера атрибутов должны быть теми же, что в объектах атрибутов, возвращаемыми API в данных профиля.

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • profile.identifier.used
  • request.validation.failed

Подробнее см. Коды ошибок.

Получить баланс OTT

GET /(company_code)/v2/aol/profile/(profile_code)/ottbalance

Получить баланс бонусных баллов OTT для профиля

У запрошенного профиля должна быть роль CLIENT и экземпляр с UID OTT.

Заголовки запроса:
 
  • Authorization – Bearer <сессионный_токен>, либо Signature <подпись>
Параметры:
  • profile_code – Код запрашиваемого профиля. Для всех пользователей принимается мнемокод профиля. Для пользователей с ролью PARTNER перед мнемокодом проверяется внешний идентификатор профиля для профилей с ролью CLIENT.
JSON-объект ответа:
 
  • status (string) – success или error
  • data (integer/null) – Баланс OTT (null, если OTT не возвратили данные баланса)
  • error_code (string) – (Необязательно) Если status содержит error: один из перечисленных ниже кодов ошибки

Используемые коды ошибки

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted
  • object.id.notfound

Подробнее см. Коды ошибок.