O que é#
Na consulta CCC - Cadastro centralizado de Contribuintes você pesquisa por contribuintes de ICMS de todos os estados do Brasil.
Esta consulta só está disponível via API
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/cadastro-centralizado-contribuinte
URL Base: https://api.plexi.com.br/
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 |
|---|---|---|---|
| uf | string | Sim | Unidade da federação. Este campo é preenchido com a sigla do estado ou Distrito Federal ( df ). |
| cpfCnpj | string | Obrigatório caso o campo inscricaoEstadual não seja informado | CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
| inscricaoEstadual | string | Obrigatório caso o campo cpfCnpj não seja informado | Inscrição Estadual a ser pesquisada, com ou sem máscara |
| certificate | string | Sim se não fornecido credential | Certificado a ser utilizado para autenticação. |
| credential | string | Sim se não fornecido certificate | Credencial a ser utilizada para autenticação |
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
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
Significa que ocorreu um erro de validação dos dados enviados.
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo nome é obrigatório."
]
}
}Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| cadastrado | Empresa ou pessoa foi encontrada e está cadastrada |
| erro | Contribuinte não localizado no Cadastro Centralizado de Contribuintes ou não está associado à UF informada. |
Resposta com registro encontrado
JSON
{
"status": "cadastrado",
"nome": "EMPRESA EXEMPLO LTDA",
"cnpj": "99.999.999/9999-99",
"inscricaoEstadual": "999999999",
"situacaoCnpj": "Sem restrição",
"situacaoIe": "Habilitado",
"tipoIe": "IE Normal",
"dataSituacaoUf": "01/01/2020",
"nomeFantasia": "EMPRESA EXEMPLO LTDA",
"dataInicioAtividade": "01/01/2020",
"dataFimAtividade": "01/01/2020",
"regimeTributacao": "Normal",
"informacaoIeComoDestinatario": "Obrigatória",
"porteEmpresa": "Demais empresas",
"cnaePrincipal": "1412601",
"endereco": {
"municipioIbge": "9999999 - Cidade Exemplo",
"uf": "SC",
"logradouro": "RUA EXEMPLO",
"numero": "123",
"complemento": "Nao Informado",
"bairro": "BAIRRO EXEMPLO",
"cep": "99999999"
},
"historico": [
{
"numero": "999999999",
"regimeIcms": "Normal",
"dataSituacao": "01/01/2020",
"dataAtualizacao": "01/01/2020",
"motivo": "Alteração"
},
{
"numero": "999999999",
"regimeIcms": "Normal",
"dataSituacao": "01/01/2020",
"dataAtualizacao": "01/01/2020",
"motivo": "Alteração"
},
{
"numero": "999999999",
"regimeIcms": "Não informado",
"dataSituacao": "01/01/2020",
"dataAtualizacao": "01/01/2020",
"motivo": "Inclusão"
}
]
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Contribuinte não localizado no Cadastro Centralizado de Contribuintes ou não está associado à UF informada.",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
