O que é
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/jucesp/certidao-simplificada
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 |
---|---|---|---|
cpf | string | Sim | CPF de login |
senha | string | Sim | Senha para login |
nire | string | Apenas se não for passado valor em | NIRE a ser pesquisado. |
nome | string | Apenas se não for passado valor em | Nome a ser pesquisado |
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 |
---|---|
indefinido | Não foi possível determinar o status da empresa |
cadastrado | Empresa contém registro na Jucesp |
erro | Erro ao buscar informações, seja por documento ou outro dado incorreto |
Respostas com registro encontrado
{ "numeroAutenticidade": "157759408", "status": "cadastrado", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
{ "status": "indefinido", "empresas": [ { "nire": "35300010230", "nome": "EMPRESA UNIBANCO HOLDING S.A.", "municipio": "SAO PAULO" }, { "nire": "35300331028", "nome": "EMPRESA SEGUROS CORPORATIVOS S.A.", "municipio": "SAO PAULO" }, { "nire": "35300319303", "nome": "EMPRESA FINANCEIRA S.A. - CREDITO, FINANCIAMENTO E INVESTIMENTO", "municipio": "SAO PAULO" } ], "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
Resposta com erro
{ "status": "erro", "mensagem": "NIRE inexistente.", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }
{ "status": "erro", "mensagem": "Não foi possível autenticar o usuário: CPF ou Senha inválidos", "pdf": "JVBERi0xLjQKMSAwIG9iago8..." }