Коды подтверждения

Коды подтверждения предназначены для верификации электронного адреса и номера телефона пользователя.

API

Получить

POST /api/v1/verification/<agent>/code

Создать и получить код подтверждения.

Где <agent>:

• mail - Для электронного адреса;
• phone - Для номера телефона;

Параметры запроса:

Имя	Тип	Значение	Описание
code	STRING		Необязательный. Код подтверждения. Если код не указан система создаст его автоматически.

Формат ответа:

Поле	Тип	Описание
id	UUID	Идентификатор.
type	STRING	Тип: mail - электронный адрес; phone - номера телефона.
code	STRING	Код подтверждения.
used	BOOL	Использован: Да/Нет.
validfromdate	TIMESTAMP	Дата начала периода действия.
validtodate	TIMESTAMP	Дата окончания периода действия.

Сверить

POST /api/v1/verification/<agent>/confirm

Сверяет код подтверждения.

Где <agent>:

• mail - Электронный адрес;
• phone - Номер телефона;

Параметры запроса:

Имя	Тип	Значение	Описание
code	STRING		Обязательный. Код подтверждения.

Формат ответа:

Поле	Тип	Описание
result	BOOL	Результат: Да/Нет.
message	STRING	Текст ошибки.

Получить

POST /api/v1/verification/get

Возвращает код подтверждения.

Параметры запроса:

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор записи.
fields	JSON array		Необязательный. Массив JSON string полей в таблице, если не указано то запрос вернет все поля.

Список

POST /api/v1/verification/list

Возвращает коды подтверждения.

Параметры запроса: Общие параметры запроса для списка