Pular para o conteúdo principal
POST
curl
A Verificação bancária ainda não está habilitada em produção. Até que esteja, este endpoint responde 404 com code: bank_verification_not_available, e você não pode adicionar a etapa de Verificação bancária a um fluxo de verificação (workflow) de produção. Esta página descreve como o endpoint se comporta quando estiver disponível.
Seu backend envia o nome e a conta e lê o resultado. É a verificação de conta da etapa de Verificação bancária, sem incluir a pessoa.

Envie a conta no formato usado pelo país dela

Alguns países também exigem um bic e, para uma conta empresarial, um registration_id. Espaços, hífens e pontos são ignorados. Se faltar uma chave de que a verificação do país precisa, a resposta é um 400 que a identifica, por exemplo "field": "account.sort_code", "reason": "required". Envie holder.full_name para verificar a conta de uma pessoa, ou holder.business_name para verificar a de uma empresa.

Leia o resultado

Faturamento e novas tentativas

Cada verificação respondida pelo banco é cobrada uma vez pelo preço da verificação de conta do país da conta, qualquer que seja o resultado. Uma requisição respondida com erro nunca é cobrada: um payload recusado (400), falta de crédito (402), uma conta que ainda não é atendida por nenhuma verificação (404) ou um banco que não conseguiu responder (503). Não há chave de idempotência nem endpoint para consultar uma verificação depois. Uma requisição tentada novamente executa uma nova verificação, com um novo request_id, e é cobrada novamente; por isso, armazene a resposta. A Didit armazena apenas a cobrança, com o ID da requisição, o país, o resultado e a conta mascarada, nunca o nome nem o número completo da conta.

Teste no sandbox

Uma chave de API de sandbox não consulta nenhum banco e não gera cobrança. Os 4 últimos caracteres do IBAN ou, na falta dele, do número da conta definem a resposta: IBAN, CLABE e CBU têm dígitos verificadores: use os valores de sandbox que passam em todas as verificações de formato.

Acesso

Autentique-se com a x-api-key da sua aplicação ou com o token bearer de credenciais do cliente dela. Uma chave de API com escopo precisa de permissão de escrita nas sessões. O endpoint compartilha o limite de escrita de 300 requisições por minuto por chave de API.

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Corpo

application/json
country
string
obrigatório

O país da conta, como código ISO 3166-1 alfa-3, por exemplo GBR. Letras minúsculas são aceitas.

Required string length: 3
Exemplo:

"GBR"

account
object
obrigatório

A conta no formato usado pelo país dela: um iban, ou um account_number com o código de banco ou de agência que o país exige (sort_code, routing_number, transit_institution, bsb, ifsc, bank_code ou bic). O México usa uma clabe e a Argentina um cbu_cvu, que já identificam o banco. Uma conta empresarial inclui um registration_id quando o país exige. Espaços, hifens e pontos são ignorados. Chaves que a verificação do país não usa são ignoradas. Uma chave exigida que não é enviada resulta em um 400 que a identifica.

Exemplo:
holder
object
obrigatório

O nome com o qual a conta é verificada. Envie exatamente um entre full_name e business_name.

vendor_data
string | null

Sua própria referência para esta verificação, retornada sem alterações.

Exemplo:

"payout_20481"

Resposta

O banco respondeu. A verificação é cobrada, seja qual for o resultado.

request_id
string<uuid>
obrigatório

O ID desta verificação.

result
enum<string>
obrigatório

match: o banco mantém a conta no nome que você enviou. close_match: em um nome parecido, por exemplo sem o nome do meio ou com um erro de digitação. no_match: em outro nome, ou essa conta não existe. cannot_verify: o banco respondeu sem comparar o nome, por exemplo no caso de uma conta bloqueada ou encerrada.

Opções disponíveis:
match,
close_match,
no_match,
cannot_verify
holder_name
string | null
obrigatório

Somente em um close_match, e somente quando o banco o retornou: o nome na conta, conforme registrado pelo banco. null caso contrário.

account
string
obrigatório

A conta, mascarada até os 4 últimos caracteres.

vendor_data
string | null
obrigatório

Sua própria referência, conforme você a enviou.

created_at
string<date-time>
obrigatório

Quando a verificação foi executada, em UTC.

Última modificação em 1 de novembro de 2026