O que é

Na consulta CADIN - Cadastro Informativo dos Créditos não Quitados de Órgãos e Entidades Estaduais - você verifica se uma pessoa ou empresa está em uma das situações:

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/fazenda-sp/cadin

URL Base:

Parâmetros do header

Nome

Tipo

Obrigatório?

Descrição

Authorization

String

Sim

Chave de API gerada no cadastro no Plexi, prefixada com Bearer

Callback

String

Não

URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros do body

Nome

Tipo

Obrigatório?

Descrição

cpfCnpj

string

Sim

CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99

Retornos possíveis da requisição

Status

Significado

Descrição

Informações retornadas

201

Created

Solicitação criada

Campo requestId, com o ID da requisição criada.

422

Unprocessable Entity

A solicitação contém erro

Em quais campos houve erro.

Exemplos de retornos

Status 201

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

 

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status

Significado

negativa

NÃO foram encontrados débitos para o documento pesquisado

positiva

Foram encontrados débitos relacionados ao documento pesquisado

Resposta com registro encontrado

{
  "dividas": [
    {
      "entidade": "Procuradoria Geral do Estado",
      "dataInclusao": "20/02/2014",
      "pendencias": "1",
      "localRegularizacao": "Avenida Rangel Pestana, 300, Térreo, SAO PAULO."
    },
    {
      "entidade": "DESENVOLVE SP - AGÊNCIA DE FOMENTO DO ESTADO DE SP S.A",
      "dataInclusao": "28/10/2019",
      "pendencias": "1",
      "localRegularizacao": "RUA DA CONSOLAÇÃO, 371, SAO PAULO."
    }
  ],
  "status": "positiva",
  "codigoDeclaracao": "63C2105A.8E7C389C.6D3F8148.30A95B0D",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
  "status": "negativa",
  "dividas": [],
  "codigoDeclaracao": "0039F197.09AFC8AD.E76BC82D.BC3212E0",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}