O que é#
Na consulta SICAF - Consulta Restrição Contratar Administração é possível verificar a situação de uma pessoa na participação de licitações públicas para compras realizadas pelos órgãos públicos.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/sicaf/consulta-restricao-contratar-administracao-publica
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
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpfCnpj": [
"CPF ou CNPJ inválido"
]
}
}Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| idoneo | Documento está com a situação idônea |
Resposta com documento encontrado
JSON
{
"status": "idoneo",
"cpfCnpj": "99.999.999/9999-99",
"razaoSocial": "EMPRESA EXEMPLO LTDA",
"nomeFantasia": "EXEMPLO",
"situacaoCadastral": "Credenciado",
"pdf": "JVBERi0xLjQKMSAwIG9iago8P..."
}JSON
{
"status": "idoneo",
"cpfCnpj": "999.999.999-99",
"nome": "FULANO DE TAL",
"situacaoCadastral": "Credenciado",
"pdf": "JVBERi0xLjQKMSAwIG9iago8P..."
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Não credenciado",
"pdf": "JVBERi0xLjQKMSAwIG9iago8P..."
}
