/api/CertidaoConjuntaDebitosPessoaFisica
💡 O endpoint
/api/CertidaoConjuntaDebitosPessoaFisica
permite consultar a Certidão Conjunta de Débitos (CCD) de uma pessoa física. A CCD é uma prova de regularidade que comprova a inexistência de pendências financeiras, civis ou criminais em âmbito federal, estadual e municipal.
Introdução
A API CCD - Certidão Conjunta de Débitos - Pessoa Física oferece informações detalhadas sobre a situação fiscal e legal de uma pessoa física, incluindo:
- Dados básicos de cadastro;
- Situação financeira e legal perante os órgãos públicos;
- Lista de pendências (se existentes).
Essa API é ideal para prevenção de autuações fiscais, onboarding de clientes e fornecedores, e análise de risco/crédito.
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br
Endpoint
GET /api/CertidaoConjuntaDebitosPessoaFisica
Esse endpoint retorna informações detalhadas sobre a Certidão Conjunta de Débitos de uma pessoa física.
Regras
- Apenas um CPF deve ser enviado por requisição.
- É possível incluir a geração de um comprovante PDF por um custo adicional.
Autenticação
A autenticação é feita utilizando um TOKEN. Sem um token válido, o acesso será negado (401
).
Regras de Autenticação
- O
TOKEN
deve ser incluído como parâmetro obrigatório. - Caso o token seja inválido ou expirado, entre em contato pelo e-mail: suporte@directd.com.br.
Campos da API
Dados Retornados
- Título: Título da certidão emitida.
- CPF: Cadastro de Pessoa Física.
- Nome: Nome completo da pessoa.
- Portaria: Detalhes legais vinculados à certidão.
- Emitida às: Data e hora de emissão da certidão.
- Válida Até: Data de validade da certidão.
- Status: Situação atual da certidão.
- Flag Dívidas: Indica se há dívidas registradas.
- Lista de Dívidas: Lista de pendências financeiras ou legais.
- Código de Controle da Certidão: Código único de controle da certidão.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CPF | string | Sim | CPF da pessoa (com ou sem formatação). |
TOKEN | string | Sim | Token de autenticação. |
GERARCOMPROVANTE | string | Não | Indica se deve gerar comprovante em PDF (habilitar ). |
Exemplo de Requisição
Usando cURL
curl -X 'GET' \
'https://apiv3.directd.com.br/api/CertidaoConjuntaDebitosPessoaFisica?CPF=12345678901&TOKEN=68ADA2C3-8016-47DA-ADE6-13AE239308FE&GERARCOMPROVANTE=habilitar' \
-H 'accept: application/json'
Respostas
Sucesso (200)
A consulta foi realizada com sucesso e retorna os dados da CCD.
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "CCD - Certidão Conjunta de Débitos - Pessoa Física",
"consultaUid": "direct-123456",
"mensagem": "Consulta realizada com sucesso.",
"resultado": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 150,
"gerarComprovante": true,
"urlComprovante": "https://apiv3.directd.com.br/comprovantes/123456.pdf"
},
"retorno": {
"titulo": "Certidão Conjunta de Débitos",
"cpf": "12345678901",
"nome": "João da Silva",
"portaria": "Portaria 123/2024",
"emitidaAs": "01/01/2024 10:00:00",
"validaAte": "31/12/2024",
"status": "Regular",
"possuiDividas": false,
"listaDividas": [],
"codigoControleCertidao": "ABCDE12345"
}
}
Erros Comuns
Código | Descrição |
---|---|
400 | Requisição inválida: parâmetros incorretos. |
401 | Não autenticado: token inválido ou ausente. |
403 | Não autorizado: saldo insuficiente. |
404 | Não encontrado: registro não localizado. |
Notas Importantes
- Apenas um CPF deve ser enviado por consulta.
- O parâmetro
GERARCOMPROVANTE
é opcional e, se ativado, gera um PDF do comprovante. - Para dúvidas ou suporte, entre em contato pelo e-mail: suporte@directd.com.br.