Validação do hash e do código numérico

Este endpoint permite realizar a validação do hash e do código numérico recebido pelo cliente de nosso parceiro.

Requisição

Requisição HTTP

PATCH 'https://api-mtls.sandbox.bankly.com.br/totp

curl  --request PATCH \
			--url 'https://api-mtls.sandbox.bankly.com.br/totp' \ 
			--header 'api-version: 1' \ 
			--header 'x-bkly-user-id: {{document_number}}' \ 
			--header 'Content-Type: application/json' \ 
			--header 'Accept: application/json' \ 
			--header 'Authorization: Bearer {{access_token}}' \ 
			--data-raw '{ 
			    "hash": "a40296c70ebc780c917aa510aad8aeb3c83c3ce86e0fc3b7149019a75cdb4122", 
			    "code": "123456" 
			}

Autorização

Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:

Cabeçalhos (Headers)

Parâmetros da rota (Path)

Não é necessário enviar parâmetros no path desta requisição.

Corpo da requisição (Body)

No body, envie os seguintes campos em formato JSON:

{ 
    "hash": "a40296c70ebc780c917aa510aad8aeb3c83c3ce86e0fc3b7149019a75cdb4122", 
    "code": "123456" 
}

Resposta (Response)

O status code 200 indicará sucesso na validação.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

{ 
   "hash": “a40296c70ebc780c917aa510aad8aeb3c83c3ce86e0fc3b7149019a75cdb4122”, 
   "expirationInSeconds": 300 
}

🚧

Importante

Após a validação, o hash irá expirar em 5 minutos. Caso a solicitação do cadastro de chaves ou pedido de portabilidade/reivindicação não ocorra dentro desse período, um novo código TOTP deve ser gerado.

👍

Dica

Para simular uma requisição nesse endpoint, acesse o API Reference.

Erros

Este endpoint pode retornar erros específicos, conforme a tabela a seguir:

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints. Portanto, recomendamos a consulta da documentação de erros, onde é possível encontrar as mensagens comuns em inglês que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.