Um endpoint para cancelar uma comprovação.
O estado do comprovante precisa ser "pendente", "contestada" ou "cancelada". Caso contrário, um invalidState ErrorResponse precisa ser retornado.
Solicitação HTTP
POST https://example.issuer.com/api/v1/vdc/cancelProofing
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 O estado do comprovante precisa ser "pendente", "contestada" ou "cancelada". Caso contrário, um invalidState ErrorResponse precisa ser retornado. |
Corpo da resposta
Uma resposta a uma solicitação de cancelamento de uma comprovação.
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. |