- HTTP-запрос
- Текст запроса
- Ответный текст
- ProofingStates
- В ожидании
- Принял
- Отклоненный
- Отказ
- Несоответствие доказательств
- Доказательства неполные
- Низкий показатель риска
- Запись не найдена
- RecordInvalid
- Достигнут максимальный уровень резервирования.
- RiskCheckFailure
- Сбой проверки работоспособности
- Вызов
- Физическое местоположениеПосещение
- IssuerUrlVisit
- Дополнительное время, необходимое для выполнения
- Отменено
- Отменено
- Истекший
Конечная точка для получения текущего статуса проверки.
HTTP-запрос
POST https://example.issuer.com/api/v1/vdc/getProofingStatus
Текст запроса
Тело запроса содержит данные следующей структуры:
| JSON-представление |
|---|
{
"requestMetadata": {
object ( |
| Поля | |
|---|---|
requestMetadata | Метаданные о запросе, необходимые для всех запросов. |
deviceReferenceId | Идентификатор, соответствующий устройству, и ключ идентификации, связанный с устройством. Это НЕ идентификатор устройства, то есть, если у пользователя будут две разные учетные данные на одном устройстве, этот идентификатор будет отличаться для них. Этот идентификатор указывается во всех запросах и может использоваться для сопоставления запросов. |
proofingId | Непрозрачный идентификатор, представляющий собой проверку с использованием определенного набора доказательств для конкретного устройства. Пример: UUID |
Ответный текст
Ответ, содержащий текущий статус проверки.
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{ "responseMetadata": { object ( |
| Поля | |
|---|---|
responseMetadata | Метаданные об ответе, обязательные для всех ответов. |
proofingStatus | Текущий статус проверки. |
ProofingStates
Объект, представляющий различные статусы, которые может иметь проверка текста.
| JSON-представление |
|---|
{ // Union field |
| Поля | |
|---|---|
status поля объединения. Объект типа «один из», содержащий различные возможные статусы для проверки. status может принимать только один из следующих значений: | |
pending | Статус «ожидание» указывает на то, что эмитент еще не принял решения. |
accepted | Статус «принято», указывающий на то, что эмитент принял проверку. |
rejected | Статус «Отклонено» означает, что эмитент отклонил проверку. |
challenged | Статус «Проверка подтверждена», указывающий на то, что эмитент хотел бы, чтобы пользователь завершил проверку перед принятием решения о подтверждении подлинности. |
canceled | Статус «Отменено» означает, что пользователь отменил проверку. |
revoked | Статус «отменено» означает, что эмитент отозвал подтверждение. |
expired | Статус "истек" указывает на то, что решение по проверке не было принято (вероятно, из-за незавершенной проверки) до крайнего срока, установленного эмитентом. |
В ожидании
Этот тип не содержит полей.
Объект, представляющий статус ожидания. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Принял
Этот тип не содержит полей.
Объект, отображающий статус подтверждения проверки.
Отклоненный
Объект, отображающий статус отклоненной проверки.
| JSON-представление |
|---|
{ "primaryRejection": { object ( |
| Поля | |
|---|---|
primaryRejection | Основная причина, по которой этот вариант проверки получил статус «отклонен». |
additionalRejections[] | Дополнительные причины, если таковые имеются, по которым проверка получила статус «отклонена». |
Отказ
Объект, содержащий подробную информацию о конкретной причине отклонения, которая привела к тому, что проверка получила статус «отклонено».
| JSON-представление |
|---|
{ "rejectionDescription": string, "issuerRejectionIdentifier": string, // Union field |
| Поля | |
|---|---|
rejectionDescription | Описание этого отказа для отладки специалистами службы поддержки. Обратите внимание, что оно никогда не отображается пользователям. Оно может содержать описательный, неконфиденциальный текст, используемый для отладки. Внимание: Не указывайте в этом сообщении никакую личную информацию. |
issuerRejectionIdentifier | Этот идентификатор является специфическим для эмитента и генерируется им. Он используется исключительно в целях отладки для идентификации отказа. Именно по этому идентификатору эмитент узнает об этом отказе. |
reason отклонения reason может быть одной из следующих: | |
evidenceMismatch | Указывает на то, что проверка была отклонена из-за несоответствия подтверждающих данных. Примеры использования: - Несоответствие селфи, сделанного приложением, и изображения в системе эмитента. - Несоответствие изображения документа, полученного приложением, и изображения в системе эмитента. |
evidenceIncomplete | Указывает на то, что проверка была отклонена из-за неполноты представленных данных. Примеры использования: - Не все необходимые документы были получены эмитентом. |
lowRiskScore | (УСТАРЕЛО: используйте riskCheckFailure или livenessCheckFailure соответственно) Указывает на то, что проверка была отклонена из-за низкого показателя риска. Примеры использования: - Кошелек имеет низкий рейтинг риска. - Эмитент заблокировал этого пользователя из-за неоднократных неудачных попыток. |
recordNotFound | Указывает на то, что проверка была отклонена из-за отсутствия записи в системе эмитента. Примеры использования: - Запись не найдена в системе эмитента. - Конкретная запись исключена из системы. |
recordInvalid | Указывает на то, что проверка была отклонена из-за недопустимого состояния записи в системе эмитента. Примеры использования: - Запись находится в аннулированном состоянии. - Срок действия записи истек. |
maxProvisioningsReached | Указывает на то, что проверка была отклонена из-за предоставления доступа к документу максимально допустимому количеству устройств. |
riskCheckFailure | Указывает на то, что проверка была отклонена из-за ошибки при оценке риска. Примеры использования: - Высокий рейтинг риска, предоставленный кошельком, указывает на высокий риск мошенничества. - Эмитент оценивает запрос как имеющий высокий риск мошенничества. |
livenessCheckFailure | Указывает на то, что проверка на работоспособность была отклонена из-за сбоя. Примеры использования: - Показатель активности кошелька низкий. |
Несоответствие доказательств
Объект, указывающий на отклонение из-за несоответствия доказательств.
| JSON-представление |
|---|
{ "evidenceType": string } |
| Поля | |
|---|---|
evidenceType | Описание несовпадающих доказательств. Используется исключительно в целях отладки. |
Доказательства неполные
Объект, указывающий на неполное отклонение доказательства.
| JSON-представление |
|---|
{ "evidenceType": string } |
| Поля | |
|---|---|
evidenceType | Неполное описание имеющихся доказательств. Используется исключительно в целях отладки. |
Низкий показатель риска
Этот тип не содержит полей.
Объект, указывающий на отказ с низким уровнем риска. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Запись не найдена
Этот тип не содержит полей.
Объект, указывающий на отклонение записи, не найденной в базе данных. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
RecordInvalid
Объект, указывающий на отклонение недействительной записи.
| JSON-представление |
|---|
{ "invalidityReason": string } |
| Поля | |
|---|---|
invalidityReason | Описание причины, по которой запись недействительна. |
Достигнут максимальный уровень резервирования.
Объект, указывающий на максимальное количество выделенных ресурсов, был отклонен.
| JSON-представление |
|---|
{ "maxNumberOfProvisioningsAllowed": integer } |
| Поля | |
|---|---|
maxNumberOfProvisioningsAllowed | Максимально допустимое количество резервов, установленное политикой эмитента. |
RiskCheckFailure
Этот тип не содержит полей.
Объект, указывающий на отказ в проверке риска. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Сбой проверки работоспособности
Этот тип не содержит полей.
Объект, указывающий на отказ в проверке работоспособности. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Вызов
Объект, отображающий статус проверки, по которому были оспорены результаты.
| JSON-представление |
|---|
{ "challengeDescription": string, // Union field |
| Поля | |
|---|---|
challengeDescription | Описание задачи, которую должны решить специалисты службы поддержки при отладке. Обратите внимание, что эта информация никогда не отображается пользователям. Она может содержать описательный, неконфиденциальный текст, используемый для отладки. Внимание: Не указывайте в этом сообщении никакую личную информацию. |
challenge «Полевая игра Союза». Одно из множества заданий, которые может выполнить пользователь. challenge может быть только одним из следующих: | |
physicalLocationVisit | Задание, для выполнения которого пользователю необходимо посетить физическое место, например, офис эмитента. |
issuerUrlVisit | Вариант проверки, при котором пользователь должен перейти по предоставленному эмитентом URL-адресу и выполнить проверку по этому URL-адресу. |
additionalTimeRequired | Вариант с дополнительным заданием, требующий больше времени для проверки корректуры. |
Физическое местоположениеПосещение
Этот тип не содержит полей.
Объект, представляющий собой вариант проверки подлинности, при котором пользователь должен посетить физическое место, например, офис эмитента, чтобы пройти проверку. Этот тип проверки находится за пределами зоны действия Google. В целях безопасности, если эмитент поддерживает этот тип проверки, он должен предоставить Google информацию о местоположении во время регистрации.
IssuerUrlVisit
Этот тип не содержит полей.
Объект, представляющий вариант проверки, при котором пользователь должен перейти по предоставленному эмитентом URL-адресу и выполнить проверку по этому URL-адресу. Эта проверка осуществляется вне зоны действия Google. В целях безопасности, если эмитент поддерживает этот тип проверки, он должен предоставить URL-адрес Google во время регистрации.
Дополнительное время, необходимое для выполнения
Объект, представляющий собой вариант проверки, требующий дополнительного времени на проверку корректуры. При желании можно указать предполагаемое время завершения.
| JSON-представление |
|---|
{ "estimatedCompletion": string } |
| Поля | |
|---|---|
estimatedCompletion | Примерное время завершения проверки. Информация о проверке (если имеется). Формат — метка времени, представленная в виде количества миллисекунд с начала эпохи Unix. |
Отменено
Этот тип не содержит полей.
Объект, отображающий статус отмены проверки. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Отменено
Этот тип не содержит полей.
Объект, отображающий статус проверки, которая была отменена. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.
Истекший
Этот тип не содержит полей.
Объект, отображающий статус проверки, срок действия которой истек. В данный момент это сообщение намеренно пустое. В будущем могут быть добавлены новые поля.