Method: vdc.provisionCredential

Конечная точка для предоставления учетных данных.

HTTP-запрос

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

Текст запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
Поля
requestMetadata

object ( RequestMetadata )

Метаданные о запросе, необходимые для всех запросов.

deviceReferenceId

string

Идентификатор, соответствующий устройству, и ключ идентификации, связанный с устройством. Это НЕ идентификатор устройства, то есть, если у пользователя будут две разные учетные данные на одном устройстве, этот идентификатор будет отличаться для них.

Этот идентификатор указывается во всех запросах и может использоваться для сопоставления запросов.

credentialId

string

Непрозрачный идентификатор, представляющий собой конкретные учетные данные, предоставленные устройству.

Если идентификатор учетных данных (credentialId) уже существует, вместо создания новых учетных данных этот метод должен возвращать существующие учетные данные.

Пример: UUID

proofingId

string

Непрозрачный идентификатор, представляющий собой проверку с использованием определенного набора доказательств для конкретного устройства.

Проверка должна находиться в состоянии «Утверждено». В противном случае должен быть возвращен ErrorResponse с недопустимым идентификатором.

deviceEncryptionKey

object ( DeviceEncryptionKey )

Объект, содержащий временный ключ шифрования устройства и связанные с ним метаданные. Этот ключ используется для шифрования значения, возвращаемого на устройство. В тестовой среде во время регистрации этот объект может не предоставляться, что указывает на необходимость возврата данных в открытом виде эмитентом. В производственной среде этот параметр всегда должен быть установлен.

Ответный текст

Ответ, содержащий предоставленные учетные данные.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Поля
responseMetadata

object ( ResponseMetadata )

Метаданные об ответе, обязательные для всех ответов.

credential

object ( Credential )

Предоставленные учетные данные.

credentialVersionId

string

Текущая версия предоставленных учетных данных.

Удостоверение личности

Учетные данные в формате mdoc, определенные соответствующим стандартом ISO для данного типа учетных данных.

Например, для водительских прав, оформленных на мобильное устройство, используется стандарт ISO/IEC 18013-5. См. информацию о формате mDL mDoc здесь .

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.
}
Поля
Поле объединения presencetype . Тип данных oneof, указывающий, как представлены учетные данные. presencetype может принимать только одно из следующих значений:
encryptedData

object ( EncryptedData )

Зашифрованное значение и метаданные шифрования, необходимые для расшифровки этого значения.

unencryptedValue

string

Закодированное в base64 значение учетных данных.