Method: vdc.provisionCredential

Un endpoint per il provisioning di una credenziale.

Richiesta HTTP

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

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
Campi
requestMetadata

object (RequestMetadata)

Obbligatorio. I metadati relativi alla richiesta, obbligatori in tutte le richieste.
deviceReferenceId

string

Obbligatorio. L'ID che corrisponde al dispositivo e alla chiave di identità associata al dispositivo. NON è un ID dispositivo, il che significa che se l'utente avesse due credenziali separate sullo stesso dispositivo, questo ID sarebbe diverso tra loro.

Questo ID viene fornito in tutte le richieste e può essere utilizzato per correlare le richieste.
credentialId

string

Obbligatorio. Un identificatore opaco che rappresenta una credenziale specifica di cui è stato eseguito il provisioning su un dispositivo.

Se credentialId esiste già, anziché creare una nuova credenziale, questo metodo deve restituire la credenziale esistente.

Esempio: UUID
proofingId

string

Obbligatorio. Un identificatore opaco che rappresenta una verifica con un bundle specifico di prove per un dispositivo specifico.

La verifica deve essere nello stato Approvato. In caso contrario, deve essere restituito un ErrorResponse con identificatore non valido.
deviceEncryptionKey

object (DeviceEncryptionKey)

Obbligatorio. Un oggetto contenente la chiave di crittografia effimera del dispositivo e i metadati associati. Questa chiave viene utilizzata per criptare un valore sul dispositivo. Questo oggetto potrebbe non essere fornito nell'ambiente sandbox durante l'onboarding, il che indica che l'emittente deve restituire dati in testo normale. Questo valore deve essere sempre impostato nell'ambiente di produzione.

Corpo della risposta

Una risposta contenente la credenziale di cui è stato eseguito il provisioning.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Campi
responseMetadata

object (ResponseMetadata)

Obbligatorio. I metadati relativi alla risposta, obbligatori in tutte le risposte.
credential

object (Credential)

Obbligatorio. La credenziale di cui è stato eseguito il provisioning.
credentialVersionId

string

Obbligatorio. La versione attuale della credenziale di cui è stato eseguito il provisioning.

Qualifica

La credenziale basata su mdoc, come definita dallo standard ISO pertinente per il tipo di credenziale.

Ad esempio, per una patente di guida mobile, sarebbe ISO/IEC 18013-5. Consulta questa pagina per il formato mDoc mDL.

Rappresentazione 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.
}
Campi
Campo unione presencetype. Obbligatorio. Un oneof che indica come viene presentata la credenziale. presencetype può essere solo uno dei seguenti tipi:
encryptedData

object (EncryptedData)

Il valore criptato e i metadati di crittografia necessari per decriptare il valore.
unencryptedValue

string

Il valore con codifica Base64 della credenziale.