Method: vdc.provisionCredential

Es un extremo para aprovisionar una credencial.

Solicitud HTTP

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

Cuerpo de la solicitud

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

Representación JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
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.
credentialId

string

Es un identificador opaco que representa una credencial específica aprovisionada en un dispositivo.

Si el credentialId ya existe, en lugar de crear una credencial nueva, este método debe devolver la credencial existente.

Ejemplo: UUID
proofingId

string

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

La prueba debe estar en estado Aprobado. De lo contrario, se debe devolver un ErrorResponse con un identificador no válido.
deviceEncryptionKey

object (DeviceEncryptionKey)

Es un objeto que contiene la clave de encriptación efímera del dispositivo y los metadatos asociados. Esta clave se usa para encriptar un valor y enviarlo de vuelta al dispositivo. Es posible que este objeto no se proporcione en el entorno de zona de pruebas durante la incorporación, lo que indica que la entidad emisora debe devolver datos de texto sin formato. Este valor siempre debe establecerse en el entorno de producción.

Cuerpo de la respuesta

Es una respuesta que contiene la credencial aprovisionada.

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

Representación JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Campos
responseMetadata

object (ResponseMetadata)

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

object (Credential)

Es la credencial aprovisionada.
credentialVersionId

string

Es la versión actual de la credencial que se aprovisionó.

Credencial

Es la credencial basada en mdoc, según se define en el estándar ISO pertinente para el tipo de credencial.

Por ejemplo, para una licencia de conducir en dispositivos móviles, sería ISO/IEC 18013-5. Consulta este vínculo para ver el formato de mDoc de mDL.

Representación 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.
}
Campos
Campo de unión presencetype. Es un elemento oneof que indica cómo se presenta la credencial. presencetype puede ser solo uno de los parámetros siguientes:
encryptedData

object (EncryptedData)

Es el valor encriptado y los metadatos de encriptación necesarios para desencriptar el valor.
unencryptedValue

string

Es el valor de la credencial codificado en base64.