Descrição
A Certidão Negativa de Débitos Estaduais retorna, quando não existem débitos estaduais associados à entidade sendo consultada, uma certidão que comprova a não existência de débitos. A existência de débitos estaduais é um relevante indicador negativo de crédito. O objeto de retorno desta consulta segue o mesmo padrão de todas as consultas on-demand de certidões. Esta consulta está habilitada para todos os estados do Brasil.
Origem da Informação
As informações retornadas nesta consulta são extraídas de várias consulta públicas disponíveis por estado.
Tabela de preços para esse dataset
| Consultas Realizadas no Mês | Valor por consulta |
|---|---|
| 1 - 10000 | R$ 0,030 |
| 10001 - 50000 | R$ 0,028 |
| 50001 - 100000 | R$ 0,027 |
| 100001 - 500000 | R$ 0,026 |
| 500001 e acima | R$ 0,025 |
Parâmetros de consulta
A tabela abaixo detalha os campos aceitos na consulta a este dataset.
| Campo | Descrição | Valores Possíveis | Tipo de Campo |
|---|---|---|---|
| doc | Número do CPF | CPF | 🛑 Obrigatório |
| uf | Sigla da Unidade Federativa (estado) | AC, AL, AM, AP, BA, CE, DF, ES, GO, MA, MG, MS, MT, PA, PB, PE, PI, PR, RJ, RN, RO, RR, RS, SC, SE, SP, TO | ⚠️ Semi-Obrigatório |
| addresscore | Nome da rua sem tipologia (ex: Paulista ao invés de Avenida Paulista) | Qualquer texto | ⚠️ Semi-Obrigatório |
| addressnumber | Número do imóvel no endereço | Número | ⚠️ Semi-Obrigatório |
| addresstypology | Tipo de logradouro (Rua/Avenida/Travessa/etc) | Qualquer texto | ⚠️ Semi-Obrigatório |
| neighborhood | Nome do bairro | Qualquer texto | ⚠️ Semi-Obrigatório |
| zipcode | CEP para consulta (formato: xxxxx-xxx) | xxxxx-xxx | ⚠️ Semi-Obrigatório |
| city | Nome da cidade | Qualquer texto | ⚠️ Semi-Obrigatório |
| state | Nome do estado brasileiro | MG, RJ, SP, etc. | ⚠️ Semi-Obrigatório |
| name | Nome completo da pessoa para comparação | Qualquer texto | ⚠️ Semi-Obrigatório |
| fillmotheraddress | Busca UF com base no endereço da mãe se não houver endereço direto | true, false | ℹ️ Opcional |
| fillworkaddress | Busca UF com base no endereço do trabalho se não houver endereço direto | true, false | ℹ️ Opcional |
| birthdate | Data de nascimento do indivíduo. | yyyy-MM-dd | ℹ️ Opcional |
| dateformat | Formato dos campos do tipo data. | yyyy-MM-dd, dd/MM/yyyy | ℹ️ Opcional |
Clique aqui para saber mais sobre os parâmetros de consulta da Plataforma de Dados.
Abaixo está um exemplo de como realizar a chamada apenas com os parâmetros obrigatórios:
{
"Datasets": "ondemand_cert_debt_absence_by_state_person",
"q": "doc{CPF}"
}
Descrição dos campos do objeto principal de retorno
| Campo | Descrição |
|---|---|
| Origin | Fonte dos Dados Entregues. Para esta consulta, será sempre "Certidao Negativa de Debitos Estadual". |
| InputParameters | Parâmetros de entrada utilizados na consulta. |
| ProtocolNumber | Número de protocolo da certidão emitida, que pode ser utilizado para validação posterior da mesma. |
| BaseStatus | Status do documento consultado. Indica se consta ou não débito estadual. |
| QueryDate | Data em que a emissão da certidão foi efetuada. |
| AdditionalOutputData.State | Estado da certidão. |
| AdditionalOutputData.IsInDebt | Flag indicando se a entidade tem débitos ou não. |
| AdditionalOutputData.DocNumber | Documento da entidade. |
| AdditionalOutputData.Content | Conteúdo de texto "bruto" da certidão emitida, para conferência e registro. |
| AdditionalOutputData.DocType | Tipo do documento. |
| AdditionalOutputData.CertificateValidUntilDate | Data de expiração da certidão emitida. |
| AdditionalOutputData.CertificateIssueDate | Data de emissão da certidão. |