Validação do hash e do código numérico
stable
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:
Scope | Descrição |
---|---|
totp.validate | Concede acesso para validar o hash e o código numérico. |
Cabeçalhos (Headers)
Nome | Descrição |
---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
authorization | Obrigatório. Token de autorização do tipo Bearer. |
x-bkly-user-id | Obrigatório. Número do documento do cliente que faz a requisição. Insira apenas números, sem formatação (11 dígitos para CPF e 14 para CNPJ). |
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:
Nome | Tipo | Descrição |
---|---|---|
hash | string | Obrigatório. Hash associado ao código numérico, retornado na geração do código TOTP. |
code | string | Obrigatório. Código numérico informado pelo cliente. |
{
"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:
Nome | Tipo | Descrição |
---|---|---|
hash | string | Hash associado ao código numérico, retornado na geração do TOTP. |
expirationInSeconds | number | Tempo de expiração do hash em segundos. |
{
"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:
Status code | Código | Descrição |
---|---|---|
400 | INVALID_PARAMETER | Campo não informado ou informado com valor inválido. |
400 | INVALID_USER_ID | O header x-bkly-user-id não foi informado ou ele contém um documento inválido. |
404 | NOT_FOUND | A combinação de hash e code não foi encontrada. |
422 | ENTRY_TRANSACTIONAL_HASH_INVALID | Hash inválido. O token pode ter expirado ou o valor informado não corresponde à validação do hash. |
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.
Updated 7 months ago