Quickstart

Obtenha seu token de acesso

Acesse o painel Direct Data em Configurações → Integrações. Seu TOKEN é exibido e pode ser copiado ou regenerado a qualquer momento.

Faça sua primeira requisição

O TOKEN é passado como query parameter em todas as chamadas. Exemplo com o endpoint de consulta de CPF:

curl -X GET \
  "https://apiv3.directd.com.br/api/CadastroCpf?cpf=12345678900&TOKEN=SEU_TOKEN"

const response = await fetch(
  "https://apiv3.directd.com.br/api/CadastroCpf?cpf=12345678900&TOKEN=SEU_TOKEN"
);
const data = await response.json();
console.log(data);

import requests

data = requests.get(
    "https://apiv3.directd.com.br/api/CadastroCpf",
    params={"cpf": "12345678900", "TOKEN": "SEU_TOKEN"}
).json()
print(data)

Interprete a resposta

A resposta retorna os dados cadastrais da pessoa física diretamente no corpo JSON:

{
  "httpStatusCode": 200,
  "cpf": "123.456.789-00",
  "nome": "João da Silva",
  "sexo": "M",
  "dataNascimento": "1985-04-12",
  "situacaoCadastral": "Regular",
  "rendaEstimada": "R$ 4.500,00",
  "emails": [...],
  "telefones": [...],
  "enderecos": [...]
}

Trate os erros

Verifique sempre o campo httpStatusCode. Em caso de erro, message descreve o problema e errors[] lista os detalhes:

if (data.httpStatusCode !== 200) {
  console.error("Erro:", data.message);
  // data.errors → ["CPF inválido ou mal formatado."]
  // Códigos comuns: 400 parâmetro inválido · 401 token inválido
  //                 404 registro não encontrado · 500 erro interno
}

Explore o catálogo completo

Acesse o catálogo de APIs para ver todos os endpoints disponíveis com parâmetros, campos retornados e exemplos de código gerados automaticamente.