O que é
Na consulta Receita Federal - Comprovante de Situação Cadastral no CPF - você verifica se um CPF está em situação regular.
Veja mais informações em nossa central de ajuda: Receita Federal - Comprovante de Situação Cadastral no CPF
Sobre a requisição:
Método: POST
Endereço: URL Base + /api/maestro/receita/comprovante-situacao-cadastral
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 a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
dataNascimento | Date | Sim | Data de nascimento da pessoa no formato dia/mês/ano (DD/MM/AAAA) |
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 |
|---|---|
irregular | CPF está cadastrado e está irregular |
regular | CPF está cadastrado e está regular |
erro | Ocorre quando o documento informado não existe ou quando as informações de documento e data de nascimento estão divergentes das cadastradas. |
Resposta com registro encontrado
{
"status": "regular",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
{
"status": "irregular",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
Resposta com erro
{
"status": "erro",
"mensagem": "Data de nascimento informada está divergente da constante na base de dados da Secretaria da Receita Federal do Brasil."
}