Skip to main content
POST
Validação cadastral
Executa uma validação cadastral de pessoa física ou pessoa jurídica, comparando os dados informados com dados disponíveis na base. Use esta rota para validar cadastros, identificar divergências, apoiar onboarding, análise antifraude, revisão manual e regras internas de aprovação.

Corpo da requisição

string
required
Modelo cadastral analisado. Use pf para pessoa física ou pj para pessoa jurídica.
string
required
CPF ou CNPJ do cadastro. Pontuação é aceita e removida automaticamente.
string
Nome da pessoa ou razão social.
string
Data de nascimento em validações PF. Recomenda-se o formato yyyy-mm-dd.
string
Data de abertura em validações PJ. Recomenda-se o formato yyyy-mm-dd.
string
Nome da mãe em validações PF.
string
Nome do pai em validações PF.
string
Nome fantasia em validações PJ.
string
E-mail informado como evidência auxiliar.
string
Telefone informado como evidência auxiliar. Pontuação e prefixos são normalizados.
object
Endereço informado como evidência auxiliar.
string
Use sandbox para executar uma chamada de teste sem consumo de saldo.
Para detalhes sobre chamadas de teste, consulte Ambiente de teste.

Estrutura de address

Exemplo de corpo PF

Exemplo de corpo PJ

Os documentos acima são fictícios e servem apenas para demonstrar a estrutura da requisição.

Resposta

integer
required
Código da resposta da API.
string
required
Mensagem descritiva da resposta.
object
required
Objeto principal com o identificador da validação, cobrança, tempo de execução e resultado cadastral.

Estrutura de result

Estrutura de result.validation

Estrutura de result.cost

Estrutura de result.timing

Estrutura de result.registration

Valores de status

Estrutura de field_results

O objeto field_results é indexado pelo nome do campo comparado. Campos comuns: Cada campo comparado pode retornar:

Valores de field_results.*.status

Valores de field_results.*.impact

Estrutura de compared_data

O campo compared_data retorna apenas dados usados na comparação e pode variar conforme o modelo e os campos informados.
Campos de compared_data e field_results podem não aparecer em todas as validações. A disponibilidade depende do modelo, dos dados informados e das informações existentes na base.

Ambiente de teste

Para executar uma chamada sem consumo de saldo, envie o header:
Em chamadas de teste, test retorna true e charged retorna 0.

Respostas esperadas

As respostas possíveis estão exemplificadas no painel lateral da página.

Regras importantes

  • A credencial usada precisa possuir o escopo de validação.
  • O plano da conta precisa permitir API e validações.
  • model deve ser pf ou pj.
  • Para pf, document deve ser um CPF válido.
  • Para pj, document deve ser um CNPJ válido.
  • Envie ao menos um campo útil além do documento para obter uma validação mais conclusiva.
  • Chamadas reais debitam o valor da validação conforme o preço vigente da conta.
  • A decisão final da sua aplicação deve considerar recommended_action, score, critical_errors e sua regra de negócio interna.