Method: vdc.provisionCredential

Endpoint untuk menyediakan kredensial.

Permintaan HTTP

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

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

object (RequestMetadata)

Metadata tentang permintaan, yang diperlukan dalam semua permintaan.
deviceReferenceId

string

ID yang sesuai dengan perangkat dan kunci identitas yang terkait dengan perangkat. ID ini BUKAN ID perangkat, artinya jika pengguna memiliki dua kredensial terpisah di perangkat yang sama, ID ini akan berbeda di antara keduanya.

ID ini diberikan di semua permintaan, dan dapat digunakan untuk mengorelasikan permintaan.
credentialId

string

ID non-transparan yang merepresentasikan kredensial tertentu yang disediakan untuk perangkat.

Jika credentialId sudah ada, bukan membuat kredensial baru, metode ini akan menampilkan kredensial yang ada.

Contoh: UUID
proofingId

string

ID buram yang merepresentasikan pembuktian dengan sekumpulan bukti tertentu, untuk perangkat tertentu.

Pembuktian harus dalam status Disetujui. Jika tidak, ErrorResponse ID tidak valid harus ditampilkan.
deviceEncryptionKey

object (DeviceEncryptionKey)

Objek yang berisi kunci enkripsi sementara perangkat dan metadata terkait. Kunci ini digunakan untuk mengenkripsi nilai kembali ke perangkat. Objek ini mungkin tidak disediakan di lingkungan sandbox selama proses aktivasi, yang menunjukkan bahwa penerbit harus menampilkan data teks biasa. Setelan ini harus selalu ditetapkan di lingkungan produksi.

Isi respons

Respons yang berisi kredensial yang disediakan.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Kolom
responseMetadata

object (ResponseMetadata)

Metadata tentang respons, yang diperlukan dalam semua respons.
credential

object (Credential)

Kredensial yang disediakan.
credentialVersionId

string

Versi kredensial saat ini yang telah disediakan.

Kredensial

Kredensial berbasis mdoc, sebagaimana ditentukan oleh standar ISO yang relevan untuk jenis kredensial.

Misalnya, untuk surat izin mengemudi seluler, ini adalah ISO/IEC 18013-5. Lihat ini untuk format mDoc mDL.

Representasi 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.
}
Kolom
Kolom union presencetype. Oneof yang menunjukkan cara kredensial ditampilkan. presencetype hanya dapat berupa salah satu dari berikut:
encryptedData

object (EncryptedData)

Nilai terenkripsi dan metadata enkripsi yang diperlukan untuk mendekripsi nilai.
unencryptedValue

string

Nilai kredensial yang dienkode base64.