Method: vdc.provisionCredential

Point de terminaison pour provisionner un justificatif.

Requête HTTP

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

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,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
Champs
requestMetadata

object (RequestMetadata)

Obligatoire. Métadonnées concernant la requête, requises dans toutes les requêtes.
deviceReferenceId

string

Obligatoire. Identifiant correspondant à l'appareil et clé d'identité associée à l'appareil. Il ne s'agit PAS d'un identifiant d'appareil. Par conséquent, si l'utilisateur possède deux justificatifs distincts sur le même appareil, cet identifiant sera différent pour chacun d'eux.

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

string

Obligatoire. Identifiant opaque représentant un justificatif spécifique provisionné sur un appareil.

Si le credentialId existe déjà, cette méthode doit renvoyer le justificatif existant au lieu d'en créer un.

Exemple : UUID
proofingId

string

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

La confirmation doit présenter l'état "Approved". Si tel n'est pas le cas, un identifiant non valide ErrorResponse doit être renvoyé.
deviceEncryptionKey

object (DeviceEncryptionKey)

Obligatoire. Objet contenant la clé de chiffrement éphémère de l'appareil ainsi que les métadonnées associées. Cette clé est utilisée pour chiffrer une valeur renvoyée à l'appareil. Il est possible que cet objet ne soit pas fourni dans l'environnement de bac à sable lors de l'intégration, ce qui indique à l'émetteur qu'il doit renvoyer des données en texte brut. Cet objet doit toujours être défini dans l'environnement de production.

Corps de la réponse

Réponse contenant le justificatif provisionné.

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)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Champs
responseMetadata

object (ResponseMetadata)

Obligatoire. Métadonnées concernant la réponse, requises dans toutes les réponses.
credential

object (Credential)

Obligatoire. Justificatif provisionné.
credentialVersionId

string

Obligatoire. Version actuelle du justificatif provisionné.

Identifiant

Justificatif basé sur mdoc, comme défini par la norme ISO pertinente pour le type de justificatif.

Par exemple, il s'agit de "ISO/IEC 18013-5" pour un permis de conduire mobile. Consultez cette page pour en savoir plus sur le format mDoc mDL.

Représentation JSON 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string
  // End of list of possible types for union field presencetype.
}
Champs
Champ d'union presencetype. Obligatoire. Oneof indiquant la manière dont le justificatif est présenté. presencetype ne peut être qu'un des éléments suivants :
encryptedData

object (EncryptedData)

Valeur chiffrée et métadonnées de chiffrement nécessaires pour la déchiffrer.
unencryptedValue

string

Valeur du justificatif encodée en base64.