- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- ProofingEvidence
- Evidência
- ReverificationContext
Um endpoint para comprovar a identidade de um usuário com uma credencial digital, usando uma lista de evidências especificada pelo emissor e com 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 ( |
| Campos | |
|---|---|
requestMetadata |
Os metadados sobre a solicitação, obrigatórios para todas elas. |
deviceReferenceId |
O ID que corresponde ao dispositivo e a chave de identidade associada a ele. Este NÃO é um ID do dispositivo, ou seja, se o usuário tivesse duas credenciais separadas no mesmo dispositivo, esse ID seria diferente entre elas. Esse ID é fornecido em todas as solicitações e pode ser usado para correlacionar solicitações. |
proofingId |
Um identificador opaco que representa um comprovante com um pacote específico de evidências para um dispositivo específico. Por exemplo: UUID |
evidence[] |
A lista de evidências necessárias para comprovar a identidade de um usuário para uma credencial digital. |
Campo de união proofing_context. O contexto da comprovação. Vazio para a revisão inicial. proofing_context pode ser apenas de um dos tipos a seguir: |
|
reverificationContext |
O contexto para a 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 ( |
| Campos | |
|---|---|
responseMetadata |
Os metadados sobre a resposta, necessários em todas elas. |
proofingId |
O identificador opaco que representa um comprovante com um pacote específico de evidências para um dispositivo específico. É o mesmo ID de prova enviado na solicitação. |
ProofingEvidence
Um objeto que representa uma única evidência.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união evidence_type. Uma indicação de como a evidência está sendo apresentada. evidence_type pode ser apenas de um dos tipos a seguir: |
|
preAuthorizationCode |
Código de pré-autorização enviado pelo emissor. |
Evidência
Um objeto que representa uma única evidência.
| Representação JSON |
|---|
{ // Union field |
| Campos | |
|---|---|
Campo de união presencetype. Uma indicação de como a evidência está sendo apresentada. presencetype pode ser apenas de um dos tipos a seguir: |
|
encryptedData |
O valor criptografado e os metadados de criptografia necessários para descriptografar o valor. |
unencryptedValue |
O valor codificado em base64 da evidência. |
unencryptedInteger |
Valor inteiro da evidência. |
ReverificationContext
O contexto necessário para acionar a reverificação da credencial.
| Representação JSON |
|---|
{ "credentialId": string } |
| Campos | |
|---|---|
credentialId |
O ID da credencial em que a reverificação é realizada. |