Method: vdc.provisionCredential

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)

Obligatorio. Los metadatos sobre la solicitud, necesarios en todas las solicitudes.
deviceReferenceId

string

Obligatorio. El ID que corresponde al dispositivo y la clave de identidad asociada con el dispositivo. 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 correlacionar solicitudes.
credentialId

string

Obligatorio. 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 debería mostrar la credencial existente.

Ej.: UUID
proofingId

string

Obligatorio. Un identificador opaco que representa una prueba con un paquete específico de evidencia para un dispositivo específico.

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

object (DeviceEncryptionKey)

Obligatorio. 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 en el dispositivo. Es posible que este objeto no se proporcione en la zona de pruebas durante la incorporación, lo que indica que la entidad emisora debe mostrar datos de texto simple. Siempre debe configurarse en el entorno de producción.

Cuerpo de la respuesta

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)

Obligatorio. Los metadatos sobre la respuesta, necesarios en todas las respuestas.
credential

object (Credential)

Obligatorio. La credencial aprovisionada.
credentialVersionId

string

Obligatorio. La versión actual de la credencial que se aprovisionó.

Credencial

La credencial basada en mdoc, según lo define el estándar ISO pertinente para el tipo de credencial.

Por ejemplo, para una licencia de conducir móvil, sería ISO/IEC 18013-5. Consulta esto para ver el formato 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. Obligatorio. Un oneof que indica cómo se presenta la credencial. presencetype puede ser solo uno de los parámetros siguientes:
encryptedData

object (EncryptedData)

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

string

El valor codificado en base64 de la credencial.