Method: vdc.proofUser

Um endpoint para comprovar a identidade de um usuário com uma credencial digital, usando uma lista de evidências especificada pelo emissor e para um dispositivo específico.

Solicitação HTTP

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

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string,
  "evidence": [
    {
      object (ProofingEvidence)
    }
  ],

  // Union field proofing_context can be only one of the following:
  "reverificationContext": {
    object (ReverificationContext)
  }
  // End of list of possible types for union field proofing_context.
}
Campos
requestMetadata

object (RequestMetadata)

Obrigatório. Os metadados sobre a solicitação, necessários em todas as solicitações.
deviceReferenceId

string

Obrigatório. O ID que corresponde ao dispositivo e a chave de identidade associada a ele. Esse NÃO é um ID do dispositivo. Isso significa que, se o usuário tiver duas credenciais separadas no mesmo dispositivo, esse ID será diferente entre elas.

Esse ID é fornecido em todas as solicitações e pode ser usado para correlacionar solicitações.
proofingId

string

Obrigatório. Um identificador opaco que representa um comprovante com um pacote específico de evidências para um dispositivo específico.

Exemplo: UUID
evidence[]

object (ProofingEvidence)

Obrigatório. A lista de evidências necessárias para comprovar a identidade de um usuário com uma credencial digital.
Campo de união proofing_context. O contexto para comprovação. Vazio para a comprovação inicial. proofing_context pode ser apenas de um dos tipos a seguir:
reverificationContext

object (ReverificationContext)

O contexto para comprovação de reverificação.

Corpo da resposta

Um comprovante do pedido de comprovação de uma credencial digital de um usuário, indicando que a solicitação está sendo processada.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingId": string
}
Campos
responseMetadata

object (ResponseMetadata)

Obrigatório. Os metadados sobre a resposta, necessários em todas as respostas.
proofingId

string

Obrigatório. O identificador opaco que representa um comprovante com um pacote específico de evidências para um dispositivo específico. Esse é o mesmo ID de comprovação enviado na solicitação.

ProofingEvidence

Um objeto que representa uma única evidência.

Representação JSON 
{

  // Union field evidence_type can be only one of the following:
  "preAuthorizationCode": {
    object (Evidence)
  }
  // End of list of possible types for union field evidence_type.
}
Campos
Campo de união evidence_type. Obrigatório. Um oneof que indica como a evidência está sendo apresentada. evidence_type pode ser apenas de um dos tipos a seguir:
preAuthorizationCode

object (Evidence)

Código de pré-autorização enviado pelo emissor.

Evidência

Um objeto que representa uma única evidência.

Representação JSON 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string,
  "unencryptedInteger": integer
  // End of list of possible types for union field presencetype.
}
Campos
Campo de união presencetype. Obrigatório. Um oneof que indica como a evidência está sendo apresentada. presencetype pode ser apenas de um dos tipos a seguir:
encryptedData

object (EncryptedData)

O valor criptografado e os metadados de criptografia necessários para descriptografar o valor.
unencryptedValue

string

O valor codificado em base64 da evidência.
unencryptedInteger

integer

Valor inteiro da evidência.

ReverificationContext

O contexto necessário para acionar a reverificação da credencial.

Representação JSON 
{
  "credentialId": string
}
Campos
credentialId

string

Obrigatório. O ID da credencial em que a reverificação é realizada.