O que é
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/mpf/certidao-negativa
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 |
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 |
Estrutura da resposta
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 quando você faz a requisição:
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}
Status 422
Significa que ocorreu um erro de validação dos dados enviados.
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo name é obrigatório."
]
}
}
Exemplos de retornos do resultado da pesquisa
Valores possíveis do campo “status“
Status | Significado |
|---|---|
negativo | NÃO foram encontrados procedimentos extrajudiciais ao documento pesquisado |
positivo | Foram encontrados procedimentos extrajudiciais relacionados ao documento pesquisado |
erro | Erro ao buscar informações, seja por documento ou outro dado incorreto |
Respostas com registro encontrado
{
"status": "positivo",
"dataAtualizacao": "10/09/2021 16:17",
"dataEmissao": "10/09/2021 16:17",
"etiquetasLocalizacoes": [],
"nome": "FULANO DA SILVA",
"seloDigitalSeguranca": "1E430DA0FF3AF66AFC51654561CB1B22",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "negativo",
"cpfCnpj": "99999999999999",
"dataAtualizacao": "10/09/2021 16:17",
"dataEmissao": "10/09/2021 16:17",
"etiquetasLocalizacoes": [
{
"etiqueta": "1.14.000.000274/2020-73"
"localizacao": "PR-CE/GABPR6-FANL - FERNANDO ANTONIO NEGREIROS LIMA"
},
{
"etiqueta": "1.14.000.000274/2020-74"
"localizacao": "PR-CE/GABPR6-FANL - FERNANDO ANTONIO NEGREIROS LIMA"
}
],
"nome": "EMPRESA LTDA",
"seloDigitalSeguranca": "1E430DA0FF3AF66AFC51654561CB1B22",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
Resposta com erro
{
"status": "erro",
"mensagem": "Pessoa jurídica não localizada com o CNPJ informado!",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "erro",
"mensagem": "Pessoa física não localizada com o CPF informado!",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}