Geração do código numérico TOTP

Este endpoint permite gerar um código numérico para realizar a validação TOTP.

Pré-requisitos

Para que seja possível utilizar este endpoint, é necessário que:

O cliente possua uma conta ativa;

Requisição (Request)

Requisição HTTP

POST https://sandbox.hiperbanco.com.br/totp-code

--request POST 'https://sandbox.hiperbanco.com.br/totp-code' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}' \
--data-raw '{
  "operation": "RegisterEntry",
  "totpData": {
    "addressingKey": {
      "type": "EMAIL",
      "value": "[email protected]"
    },
    "pixKeyClaimId": "a5104f29-33a8-472e-aa69-61b152174487"
  }
}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

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	Especificação
`operation`	`string`	Obrigatório. Finalidade da geração do TOTP: “Portability” (portabilidade), “Ownership” (reivindicação) e “RegisterEntry” (cadastro de chaves).	-
`totpData`	`object`	Obrigatório. Campo dinâmico para que o parceiro insira as informações necessárias a serem enviadas, de acordo com a operação (operation).	-
`totpData.addressingKey`	`object`	Obrigatório. Objeto que deverá conter os dados da chave de endereçamento.	-
`totpData.addressingKey.type`	`string`	Obrigatório. Tipo da chave de endereçamento	-
`totpData.addressingKey.value`	`string`	Obrigatório. Valor da chave de endereçamento	-
`pixKeyClaimId`	`string`	Informe o valor retornado ao requisitar a portabilidade de uma chave ou reivindicar sua posse. Este campo será obrigatório caso o tipo de operação (operation) seja "Portability" ou "Ownership".	-

{
  "operation": "RegisterEntry",
  "totpData": {
    "addressingKey": {
      "type": "EMAIL",
      "value": "[email protected]"
    },
    "pixKeyClaimId": "a5104f29-33a8-472e-aa69-61b152174487"
  }
}

Resposta (Response)

O status code 204 indicará que a chave foi excluída com sucesso.

Erros

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

Status Code	Código	Mensagem	Descrição
400	PIX_KEY_DATA_REQUIRED	Pix key data is mandatory for generating a TOTP code to register new keys.	Os dados da chave PIX são obrigatórios para gerar um código TOTP para registrar novas chaves.
400	INVALID_PHONE_NUMBER_AS_PIX_KEY	Invalid phone number to register as Pix key.	Número de telefone inválido para cadastro como chave Pix.
400	PIX_KEY_CLAIM_ID_REQUIRED	Pix key claim ID is required for generating TOTP code to complete or cancel Pix key claims..	O ID da solicitação da chave Pix é necessário para gerar o código TOTP para concluir ou cancelar solicitações de chave Pix.
404	ONBOARDING_NOT_FOUND	Onboarding not found with ID	Onboarding não encontrado.
404	PIX_KEY_CLAIM_NOT_FOUND	Pix key claim not found with ID	A reivindicação da chave Pix não foi encontrada.

Recordamos que esta API também poderá retornar erros comuns entre todos os endpoints que acompanham os erros 400 (se houver).

Eventos

Este endpoint não possui eventos relacionados a ele.