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

Envie o TOKEN no header Authorization: Bearer — é a forma recomendada, porque mantém o token fora da URL e, portanto, fora de log de servidor, proxy e histórico de browser. Exemplo com o endpoint de cadastro de pessoa física:

curl -X GET \
  "https://apiv3.directd.com.br/api/CadastroPessoaFisica?CPF=12345678900" \
  -H "Authorization: Bearer SEU_TOKEN"

const response = await fetch(
  "https://apiv3.directd.com.br/api/CadastroPessoaFisica?CPF=12345678900",
  { headers: { Authorization: "Bearer SEU_TOKEN" } }
);
const data = await response.json();
console.log(data);

import requests

data = requests.get(
    "https://apiv3.directd.com.br/api/CadastroPessoaFisica",
    params={"CPF": "12345678900"},
    headers={"Authorization": "Bearer SEU_TOKEN"}
).json()
print(data)

Interprete a resposta

Toda resposta tem dois blocos: metaDados, com o resultado da consulta (resultado, mensagem, consultaUid para rastreio, tempoExecucaoMs), e retorno, com os dados da consulta:

{
  "metaDados": {
    "consultaNome": "Cadastro - Pessoa Física - Básica",
    "consultaUid": "direct-...",
    "resultado": "Sucesso",
    "mensagem": "...",
    "apiVersao": "v3",
    "tempoExecucaoMs": 180
  },
  "retorno": {
    "cpf": "123.456.789-00",
    "nome": "João da Silva",
    "sexo": "M",
    "dataNascimento": "1985-04-12",
    "nomeMae": "...",
    "rendaEstimada": "...",
    "telefones": [...],
    "enderecos": [...],
    "emails": [...]
  }
}

Trate os erros

O resultado vem no status HTTP da resposta e se repete em metaDados.resultado; metaDados.mensagem descreve o problema:

if (!response.ok) {
  console.error(response.status, data.metaDados?.mensagem);
  // 400 parâmetro inválido · 401 token inválido (ou IP não liberado)
  // 404 registro não encontrado · 408 tempo esgotado na fonte
  // 500 erro interno · 503 fonte indisponível
}

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.