/api/CADINSecretariaFazendaSP
💡 O endpoint
/api/CADINSecretariaFazendaSP
permite consultar se um CPF ou CNPJ está no Cadastro Informativo de Inadimplência (CADIN) de São Paulo e verifica pendências como débitos inscritos em dívida ativa. Este serviço é essencial para análise de risco, compliance e prevenção de autuações fiscais.
Introdução
A API CADIN - Secretaria da Fazenda de São Paulo oferece informações sobre registros de inadimplência em São Paulo, possibilitando:
- Verificação de pendências associadas a CPF/CNPJ;
- Detalhamento de pendências por entidade e data de inclusão;
- Identificação do status cadastral.
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/CADINSecretariaFazendaSP
Esse endpoint retorna informações detalhadas sobre registros no CADIN para um CPF ou CNPJ.
Regras
- Apenas um documento (CPF ou CNPJ) 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
- Documento Consultado: CPF ou CNPJ do consultado.
- Nome: Nome associado ao documento consultado.
- Código de Declaração: Código associado ao registro no CADIN.
- Data de Consulta: Data em que a consulta foi realizada.
- Total de Pendências: Número total de pendências encontradas.
- Status: Situação do registro no CADIN.
- Pendências:
- Entidade: Entidade responsável pela pendência.
- Data de Inclusão CADIN: Data em que a pendência foi registrada no CADIN.
- Quantidade de Pendências: Número de pendências registradas.
- Local de Regularização: Local para regularizar as pendências.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CPF | string | Não | CPF do consultado (com ou sem formatação). |
CNPJ | string | Não | CNPJ do consultado (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/CADINSecretariaFazendaSP?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 do registro no CADIN.
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "CADIN - Secretaria da Fazenda de São Paulo",
"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": {
"documentoConsultado": "12345678901",
"nome": "João da Silva",
"codigoDeclaracao": "CADIN12345",
"totalPendencias": 3,
"status": "Ativo",
"pendencias": [
{
"entidade": "Secretaria da Fazenda de São Paulo",
"dataInclusaoCADIN": "01/01/2023",
"quantidadePendencias": 2,
"localRegularizacao": "Secretaria da Fazenda"
}
]
}
}
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 documento (CPF ou CNPJ) 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.