Method: vdc.getProofingStatus

Es un extremo para recuperar el estado actual de una prueba.

Solicitud HTTP

POST https://example.issuer.com/api/v1/vdc/getProofingStatus

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
Campos
requestMetadata

object (RequestMetadata)

Son los metadatos sobre la solicitud, que se requieren en todas las solicitudes.

deviceReferenceId

string

Es el ID que corresponde al dispositivo y la clave de identidad asociada a él. NO es un ID de dispositivo, lo que significa que, si el usuario tuviera dos credenciales separadas en el mismo dispositivo, este ID sería diferente entre ellas.

Este ID se proporciona en todas las solicitudes y se puede usar para correlacionarlas.

proofingId

string

Es un identificador opaco que representa una verificación con un paquete específico de evidencia para un dispositivo específico.

Ejemplo: UUID

Cuerpo de la respuesta

Es una respuesta que contiene el estado actual de una prueba.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
Campos
responseMetadata

object (ResponseMetadata)

Son los metadatos sobre la respuesta, que se requieren en todas las respuestas.

proofingStatus

object (ProofingStatus)

Es el estado actual de la revisión.

ProofingStatus

Es un objeto que representa los diferentes estados que puede tener una prueba.

Representación JSON
{

  // Union field status can be only one of the following:
  "pending": {
    object (Pending)
  },
  "accepted": {
    object (Accepted)
  },
  "rejected": {
    object (Rejected)
  },
  "challenged": {
    object (Challenged)
  },
  "canceled": {
    object (Canceled)
  },
  "revoked": {
    object (Revoked)
  },
  "expired": {
    object (Expired)
  }
  // End of list of possible types for union field status.
}
Campos
Campo de unión status. Es un elemento oneof que contiene los diferentes estados posibles de una prueba. status puede ser solo uno de los parámetros siguientes:
pending

object (Pending)

Estado pendiente, que indica que la entidad emisora aún no tomó una decisión.

accepted

object (Accepted)

Es un estado aceptado que indica que la entidad emisora aceptó la verificación.

rejected

object (Rejected)

Estado rechazado, que indica que la entidad emisora rechazó la verificación.

challenged

object (Challenged)

Estado de desafío, que indica que el emisor desea que el usuario complete un desafío antes de que el emisor tome una decisión sobre la verificación.

canceled

object (Canceled)

Estado de cancelación, que indica que el usuario canceló la verificación.

revoked

object (Revoked)

Un estado revocado, que indica que la entidad emisora revocó la verificación.

expired

object (Expired)

Estado vencido, que indica que no se tomó una decisión sobre la prueba (probablemente porque no se completó un desafío) antes de la fecha límite establecida por la entidad emisora.

Pendiente

Este tipo no tiene campos.

Es un objeto que representa un estado pendiente. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Aceptado

Este tipo no tiene campos.

Es un objeto que representa un estado de prueba aceptado.

Rechazado

Es un objeto que representa un estado de prueba rechazado.

Representación JSON
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
Campos
primaryRejection

object (Rejection)

Es el motivo principal por el que esta prueba tiene el estado de rechazada.

additionalRejections[]

object (Rejection)

Son los motivos adicionales, si existen, por los que la prueba tiene el estado rechazado.

Rejection

Es un objeto que contiene detalles sobre un motivo de rechazo específico que provocó que una prueba tenga el estado de rechazada.

Representación JSON
{
  "rejectionDescription": string,
  "issuerRejectionIdentifier": string,

  // Union field reason can be only one of the following:
  "evidenceMismatch": {
    object (EvidenceMismatch)
  },
  "evidenceIncomplete": {
    object (EvidenceIncomplete)
  },
  "lowRiskScore": {
    object (LowRiskScore)
  },
  "recordNotFound": {
    object (RecordNotFound)
  },
  "recordInvalid": {
    object (RecordInvalid)
  },
  "maxProvisioningsReached": {
    object (MaxProvisioningsReached)
  },
  "riskCheckFailure": {
    object (RiskCheckFailure)
  },
  "livenessCheckFailure": {
    object (LivenessCheckFailure)
  }
  // End of list of possible types for union field reason.
}
Campos
rejectionDescription

string

Es una descripción de este rechazo para que los representantes de asistencia puedan depurar. Ten en cuenta que esto nunca se muestra a los usuarios. Puede contener texto descriptivo y no sensible que se usa para la depuración.

Advertencia: No incluyas PII en este mensaje.

issuerRejectionIdentifier

string

Este identificador es específico del emisor y lo genera el emisor. Se utiliza únicamente con fines de depuración para identificar el rechazo. Este es el identificador por el cual la entidad emisora conoce este rechazo.

Campo de unión reason. Es un elemento oneof entre los diversos motivos por los que se puede rechazar una prueba. reason puede ser solo uno de los parámetros siguientes:
evidenceMismatch

object (EvidenceMismatch)

Indica que se rechazó la verificación porque no coincidió la evidencia.

Ejemplos de uso: - No coincide la selfie capturada en la app con la imagen del sistema de la entidad emisora. - No coincide la imagen del documento de captura de la app con la imagen del sistema del emisor.

evidenceIncomplete

object (EvidenceIncomplete)

Indica que se rechazó la prueba porque no se proporcionó evidencia completa.

Ejemplos de uso: - El emisor no recibió todas las pruebas requeridas.

lowRiskScore
(deprecated)

object (LowRiskScore)

(OBSOLETO: Usa riskCheckFailure o livenessCheckFailure según corresponda).

Indica que se rechazó la verificación debido a una puntuación de riesgo baja.

Ejemplos de uso: - La billetera proporcionó una puntuación de riesgo baja. - La entidad emisora bloqueó a este usuario debido a repetidos intentos fallidos.

recordNotFound

object (RecordNotFound)

Indica que se rechazó la verificación porque el registro no existe en el sistema de la entidad emisora.

Ejemplos de uso: - No se encontró el registro en el sistema de la entidad emisora. - Se inhabilitó un registro específico.

recordInvalid

object (RecordInvalid)

Indica que se rechazó la verificación porque el registro en el sistema de la entidad emisora se encuentra en un estado no válido.

Ejemplos de uso: - El registro está en estado cancelado. - El registro venció.

maxProvisioningsReached

object (MaxProvisioningsReached)

Indica que se rechazó la prueba porque se aprovisionó el documento en la cantidad máxima de dispositivos permitidos.

riskCheckFailure

object (RiskCheckFailure)

Indica que se rechazó la verificación debido a un error en la verificación de la puntuación de riesgo.

Ejemplos de uso: - La puntuación de riesgo proporcionada por la billetera es alta, lo que representa un riesgo alto de fraude. - El emisor evalúa que la solicitud tiene un alto riesgo de fraude.

livenessCheckFailure

object (LivenessCheckFailure)

Indica que se rechazó la prueba porque falló la verificación de funcionamiento.

Ejemplos de uso: - La puntuación de detección de vida proporcionada por la billetera es baja.

EvidenceMismatch

Es un objeto que indica un rechazo por falta de coincidencia de evidencia.

Representación JSON
{
  "evidenceType": string
}
Campos
evidenceType

string

Es una descripción de la evidencia que no coincidió. Solo se usa con fines de depuración.

EvidenceIncomplete

Es un objeto que indica un rechazo por evidencia incompleta.

Representación JSON
{
  "evidenceType": string
}
Campos
evidenceType

string

Es una descripción de la evidencia que estaba incompleta. Solo se usa con fines de depuración.

LowRiskScore

Este tipo no tiene campos.

Es un objeto que indica un rechazo con una puntuación de riesgo baja. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

RecordNotFound

Este tipo no tiene campos.

Es un objeto que indica que se rechazó un registro porque no se encontró. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

RecordInvalid

Objeto que indica un rechazo de registro no válido.

Representación JSON
{
  "invalidityReason": string
}
Campos
invalidityReason

string

Es una descripción del motivo por el que el registro no es válido.

MaxProvisioningsReached

Es un objeto que indica un rechazo por haber alcanzado la cantidad máxima de aprovisionamientos.

Representación JSON
{
  "maxNumberOfProvisioningsAllowed": integer
}
Campos
maxNumberOfProvisioningsAllowed

integer

Es la cantidad máxima de aprovisionamientos permitidos, según lo establece la política de la entidad emisora.

RiskCheckFailure

Este tipo no tiene campos.

Es un objeto que indica el rechazo por falla en la verificación de riesgo. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

LivenessCheckFailure

Este tipo no tiene campos.

Es un objeto que indica el rechazo de una falla en la verificación de funcionamiento. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Con dificultades

Es un objeto que representa un estado de verificación impugnado.

Representación JSON
{
  "challengeDescription": string,

  // Union field challenge can be only one of the following:
  "physicalLocationVisit": {
    object (PhysicalLocationVisit)
  },
  "issuerUrlVisit": {
    object (IssuerUrlVisit)
  },
  "additionalTimeRequired": {
    object (AdditionalTimeRequired)
  }
  // End of list of possible types for union field challenge.
}
Campos
challengeDescription

string

Es una descripción del problema para que los representantes de asistencia puedan depurarlo. Ten en cuenta que esto nunca se muestra a los usuarios. Puede contener texto descriptivo y no sensible que se usa para la depuración.

Advertencia: No incluyas PII en este mensaje.

Campo de unión challenge. Es un campo oneof entre los diversos desafíos que el usuario puede tener que completar. challenge puede ser solo uno de los parámetros siguientes:
physicalLocationVisit

object (PhysicalLocationVisit)

Desafío en el que el usuario debe visitar una ubicación física, como la oficina de un emisor, para completarlo.

issuerUrlVisit

object (IssuerUrlVisit)

Es una opción de desafío en la que el usuario debe visitar una URL proporcionada por el emisor y completar un desafío en esa URL.

additionalTimeRequired

object (AdditionalTimeRequired)

Opción de desafío en la que se necesita más tiempo para revisar esta prueba.

PhysicalLocationVisit

Este tipo no tiene campos.

Es un objeto que representa la opción de desafío en la que un usuario debe visitar una ubicación física, como la oficina de un emisor, para completar un desafío. Este desafío está fuera de la banda de Google. Por motivos de seguridad, si la entidad emisora admite este tipo de desafío, debe proporcionar los detalles de la ubicación a Google durante la integración.

IssuerUrlVisit

Este tipo no tiene campos.

Es un objeto que representa la opción de desafío en la que un usuario debe visitar una URL proporcionada por el emisor y completar un desafío en esa URL. Este desafío está fuera de la banda de Google. Por motivos de seguridad, si la entidad emisora admite este tipo de desafío, debe proporcionar la URL a Google durante la integración.

AdditionalTimeRequired

Es un objeto que representa la opción de impugnación en la que se requiere tiempo adicional para revisar la prueba. Se puede proporcionar el tiempo de finalización estimado de forma opcional.

Representación JSON
{
  "estimatedCompletion": string
}
Campos
estimatedCompletion

string (int64 format)

Es la fecha y hora estimadas en las que se completará la corrección, así como la revisión, si está disponible. El formato es una marca de tiempo, y esta se representa como la cantidad de milisegundos desde la época Unix.

Cancelado

Este tipo no tiene campos.

Es un objeto que representa un estado de prueba cancelado. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Revocado

Este tipo no tiene campos.

Es un objeto que representa un estado de verificación revocado. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Vencido

Este tipo no tiene campos.

Es un objeto que representa un estado de verificación vencido. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.