Method: vdc.getProofingStatus

Point de terminaison pour récupérer l'état actuel d'une confirmation d'identité.

Requête HTTP

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

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string
}
Champs
requestMetadata

object (RequestMetadata)

Métadonnées de la requête, obligatoires pour toutes les requêtes.
deviceReferenceId

string

Identifiant correspondant à l'appareil et clé d'identité associée à l'appareil. Il ne s'agit PAS de l'identifiant de l'appareil, c'est-à-dire que si l'utilisateur possède deux jeux d'identifiants distincts sur le même appareil, cet identifiant sera différent pour chacun d'entre eux.

Cet identifiant est fourni dans toutes les requêtes et peut être utilisé pour corréler des requêtes.
proofingId

string

Identifiant opaque représentant une confirmation d'identité, avec un ensemble spécifique de preuves, pour un appareil spécifique.

Ex. : UUID

Corps de la réponse

Réponse contenant l'état actuel d'une confirmation d'identité.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingStatus": {
    object (ProofingStatus)
  }
}
Champs
responseMetadata

object (ResponseMetadata)

Métadonnées de la réponse, obligatoires pour toutes les réponses.
proofingStatus

object (ProofingStatus)

État actuel de la validation.

ProofingStatus

Objet représentant les différents états que peut prendre une confirmation d'identité.

Représentation 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.
}
Champs
Champ d'union status. Oneof contenant les différents états possibles d'une confirmation d'identité. status ne peut être qu'un des éléments suivants :
pending

object (Pending)

État "En attente" indiquant que l'émetteur n'a pas encore pris de décision.
accepted

object (Accepted)

État "Accepté" indiquant que l'émetteur a accepté la confirmation d'identité.
rejected

object (Rejected)

État "Refusé" indiquant que l'émetteur a refusé la confirmation d'identité.
challenged

object (Challenged)

État "Testé" indiquant que l'émetteur aimerait que l'utilisateur se soumette à un test avant de prendre une décision sur la confirmation d'identité.
canceled

object (Canceled)

État "Annulé" indiquant que l'utilisateur a annulé la confirmation d'identité.
revoked

object (Revoked)

État "Révoqué" indiquant que l'émetteur a révoqué la confirmation d'identité.
expired

object (Expired)

État "Expiré" indiquant qu'aucune décision n'a été prise concernant la confirmation d'identité (probablement en raison d'un test non effectué) avant l'échéance définie par l'émetteur.

En attente

Ce type ne comporte aucun champ.

Objet représentant l'état "En attente". Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

Accepté

Ce type ne comporte aucun champ.

Objet représentant l'état "Accepté" d'une confirmation d'identité.

Refusé

Objet représentant l'état "Refusé" d'une confirmation d'identité.

Représentation JSON 
{
  "primaryRejection": {
    object (Rejection)
  },
  "additionalRejections": [
    {
      object (Rejection)
    }
  ]
}
Champs
primaryRejection

object (Rejection)

Motif principal de l'état "Refusé" de la confirmation d'identité.
additionalRejections[]

object (Rejection)

Motifs supplémentaires, le cas échéant, de l'état "Refusé" de la confirmation d'identité.

Rejection

Objet contenant des détails sur un motif de refus spécifique, entraînant le passage à l'état "Refusé" pour une confirmation d'identité.

Représentation 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.
}
Champs
rejectionDescription

string

Description de ce refus pour que les représentants de l'assistance puissent procéder au débogage. Sachez qu'elle n'est jamais montrée aux utilisateurs. Elle peut contenir du texte descriptif non sensible utilisé pour le débogage.

Avertissement : N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce message.
issuerRejectionIdentifier

string

Cet identifiant est spécifique à l'émetteur. Il est généré par l'émetteur. Il est utilisé à des fins de débogage uniquement afin d'identifier le refus. Il s'agit de l'identifiant par lequel l'émetteur connaît ce refus.
Champ d'union reason. Oneof entre les différents motifs possibles de refus d'une confirmation d'identité. reason ne peut être qu'un des éléments suivants :
evidenceMismatch

object (EvidenceMismatch)

Indique que la confirmation d'identité a été refusée en raison d'une non-concordance des preuves.

Exemples d'utilisation : - Non-concordance entre le selfie capturé dans l'application et l'image présente dans le système de l'émetteur. - Non-concordance entre l'image du document capturée dans l'application et l'image présente dans le système de l'émetteur.
evidenceIncomplete

object (EvidenceIncomplete)

Indique que la confirmation d'identité a été refusée en raison de preuves incomplètes.

Exemples d'utilisation : - L'émetteur n'a pas reçu toutes les preuves requises.
lowRiskScore
(deprecated)

object (LowRiskScore)

(OBSOLÈTE : utilisez riskCheckFailure ou livenessCheckFailure, selon le cas)

Indique que la confirmation d'identité a été refusée en raison d'un faible score de risque.

Exemples d'utilisation : - Le score de risque fourni par le portefeuille est faible. - L'émetteur a verrouillé cet utilisateur en raison d'échecs répétés.
recordNotFound

object (RecordNotFound)

Indique que la confirmation d'identité a été refusée, car l'enregistrement n'existe pas dans le système de l'émetteur.

Exemples d'utilisation : - L'enregistrement est introuvable dans le système de l'émetteur. - Un enregistrement spécifique est désactivé.
recordInvalid

object (RecordInvalid)

Indique que la confirmation d'identité a été refusée, car l'enregistrement présente un état non valide dans le système de l'émetteur.

Exemples d'utilisation : - L'enregistrement est à l'état "Annulé". - L'enregistrement a expiré.
maxProvisioningsReached

object (MaxProvisioningsReached)

Indique que la confirmation d'identité a été refusée en raison du provisionnement du document sur le nombre maximal d'appareils autorisé.
riskCheckFailure

object (RiskCheckFailure)

Indique que la confirmation d'identité a été refusée, car la vérification du score de risque a échoué.

Exemples d'utilisation : - Le score de risque fourni par le portefeuille est élevé, ce qui représente un risque de fraude élevé. - L'émetteur estime que la demande présente un risque élevé de fraude.
livenessCheckFailure

object (LivenessCheckFailure)

Indique que la confirmation d'identité a été refusée en raison de l'échec du test de présence.

Exemples d'utilisation : - Le score de présence fourni par le portefeuille est faible.

EvidenceMismatch

Objet indiquant un refus pour non-concordance des preuves.

Représentation JSON 
{
  "evidenceType": string
}
Champs
evidenceType

string

Description des preuves non concordantes. Sert au débogage uniquement.

EvidenceIncomplete

Objet indiquant un refus pour preuves incomplètes.

Représentation JSON 
{
  "evidenceType": string
}
Champs
evidenceType

string

Description des preuves incomplètes. Sert au débogage uniquement.

LowRiskScore

Ce type ne comporte aucun champ.

Objet indiquant un refus pour faible score de risque. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

RecordNotFound

Ce type ne comporte aucun champ.

Objet indiquant un refus pour enregistrement introuvable. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

RecordInvalid

Objet indiquant un refus pour enregistrement non valide.

Représentation JSON 
{
  "invalidityReason": string
}
Champs
invalidityReason

string

Description de la raison pour laquelle l'enregistrement n'est pas valide.

MaxProvisioningsReached

Objet indiquant un refus pour nombre maximal de provisionnements atteint.

Représentation JSON 
{
  "maxNumberOfProvisioningsAllowed": integer
}
Champs
maxNumberOfProvisioningsAllowed

integer

Nombre maximal de provisionnements autorisés, tel que défini par la règle de l'émetteur.

RiskCheckFailure

Ce type ne comporte aucun champ.

Objet indiquant un refus pour échec de la vérification des risques. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

LivenessCheckFailure

Ce type ne comporte aucun champ.

Objet indiquant un refus pour échec de la vérification de présence. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

En difficulté

Objet représentant l'état "Testé" d'une confirmation d'identité.

Représentation 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.
}
Champs
challengeDescription

string

Description du test pour que les représentants de l'assistance puissent procéder au débogage. Sachez qu'elle n'est jamais montrée aux utilisateurs. Elle peut contenir du texte descriptif non sensible utilisé pour le débogage.

Avertissement : N'incluez pas d'informations permettant d'identifier personnellement l'utilisateur dans ce message.
Champ d'union challenge. Oneof entre les différents tests auxquels l'utilisateur pourrait avoir à se soumettre. challenge ne peut être qu'un des éléments suivants :
physicalLocationVisit

object (PhysicalLocationVisit)

L'utilisateur doit se rendre sur un site physique, comme le bureau de l'émetteur, pour se soumettre à un test.
issuerUrlVisit

object (IssuerUrlVisit)

L'utilisateur doit accéder à une URL fournie par l'émetteur et se soumettre à un test à cette URL.
additionalTimeRequired

object (AdditionalTimeRequired)

Option de validation pour laquelle un délai supplémentaire est nécessaire pour examiner la preuve.

PhysicalLocationVisit

Ce type ne comporte aucun champ.

Objet représentant l'option de test pour laquelle l'utilisateur doit se rendre sur un site physique, comme le bureau de l'émetteur, pour se soumettre à un test. Ce test est hors du champ d'action de Google. Pour des raisons de sécurité, si l'émetteur applique ce type de test, il doit fournir les détails relatifs au site à Google lors de l'intégration.

IssuerUrlVisit

Ce type ne comporte aucun champ.

Objet représentant l'option de test pour laquelle l'utilisateur doit accéder à une URL fournie par l'émetteur et se soumettre à un test à cette URL. Ce test est hors du champ d'action de Google. Pour des raisons de sécurité, si l'émetteur applique ce type de test, il doit fournir l'URL à Google lors de l'intégration.

AdditionalTimeRequired

Objet représentant l'option de test pour laquelle un délai supplémentaire est nécessaire pour examiner la preuve. Vous pouvez éventuellement fournir la durée d'exécution estimée.

Représentation JSON 
{
  "estimatedCompletion": string
}
Champs
estimatedCompletion

string (int64 format)

Heure estimée à laquelle la relecture sera terminée. Le format est un code temporel, qui est représenté par le nombre de millisecondes écoulées depuis l'époque Unix.

Annulé

Ce type ne comporte aucun champ.

Objet représentant l'état "Annulé" d'une confirmation d'identité. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

Révoqué

Ce type ne comporte aucun champ.

Objet représentant l'état "Révoqué" d'une confirmation d'identité. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.

Expiré

Ce type ne comporte aucun champ.

Objet représentant l'état "Expiré" d'une confirmation d'identité. Ce message est volontairement vide pour l'instant. De nouveaux champs pourront être ajoutés à l'avenir.