Point de terminaison pour vérifier l'identité d'un utilisateur pour une pièce d'identité numérique, à l'aide d'une liste de preuves spécifiée par l'émetteur et pour un appareil spécifique.
Requête HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
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 ( |
| Champs | |
|---|---|
requestMetadata |
Métadonnées de la requête, obligatoires pour toutes les requêtes. |
deviceReferenceId |
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 |
Identifiant opaque représentant une confirmation d'identité, avec un ensemble spécifique de preuves, pour un appareil spécifique. Ex. : UUID |
evidence[] |
Liste des preuves nécessaires pour vérifier l'identité d'un utilisateur pour un identifiant numérique. |
Champ d'union proofing_context. Contexte de la validation. Vide pour la validation initiale. proofing_context ne peut être qu'un des éléments suivants : |
|
reverificationContext |
Contexte de la validation pour la revalidation. |
Corps de la réponse
Accusé de réception d'une requête de vérification de l'identité d'un utilisateur pour un identifiant numérique, qui indique que la confirmation d'identité est en cours de traitement.
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 ( |
| Champs | |
|---|---|
responseMetadata |
Métadonnées de la réponse, obligatoires pour toutes les réponses. |
proofingId |
Identifiant opaque représentant une confirmation d'identité, avec un ensemble spécifique de preuves, pour un appareil spécifique. Il s'agit du même ID de preuve que celui envoyé dans la requête. |
ProofingEvidence
Objet représentant un unique élément de preuve.
| Représentation JSON |
|---|
{ // Union field |
| Champs | |
|---|---|
Champ d'union evidence_type. Oneof indiquant la manière dont la preuve est présentée. evidence_type ne peut être qu'un des éléments suivants : |
|
preAuthorizationCode |
Code de préautorisation envoyé par l'émetteur. |
Preuves
Objet représentant un unique élément de preuve.
| Représentation JSON |
|---|
{ // Union field |
| Champs | |
|---|---|
Champ d'union presencetype. Oneof indiquant la manière dont la preuve est présentée. presencetype ne peut être qu'un des éléments suivants : |
|
encryptedData |
Valeur chiffrée et métadonnées de chiffrement nécessaires pour la déchiffrer. |
unencryptedValue |
Valeur de la preuve encodée en base64. |
unencryptedInteger |
Valeur entière de la preuve. |
ReverificationContext
Contexte requis pour déclencher une nouvelle validation des identifiants.
| Représentation JSON |
|---|
{ "credentialId": string } |
| Champs | |
|---|---|
credentialId |
ID du justificatif pour lequel la revalidation est effectuée. |