Validações de um relatório
Como obter todas as validações utilizadas em um relatório ?
Para obter todas as validações realizadas em um relatório anteriormente criado, basta realizar uma simples requisição com o método GET para a nossa API no seguinte endpoint: https://api-v2.idwall.co/relatorios/{numero_do_relatorio}/validacoes substituindo o parâmetro {numero_do_relatorio} pelo real número do relatório como mostra o exemplo abaixo.
curl -X GET https://api-v2.idwall.co/relatorios/numero_do_relatorio/validacoes
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
Exemplo de sucesso
{
"result": {
"atualizado_em": "2018-11-19T19:39:43.565Z",
"mensagem": "Válido.",
"nome": "consultaPessoaDefault",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "VALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.cpf.RegraNomeReceitaFederal",
"nome": "Nome na Receita Federal",
"descricao": "Nome deve ser igual ao cadastrado na Receita Federal",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.protestos.RegraProtestos",
"nome": "Protestos",
"descricao": "Não devem constar protestos",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
"nome": "Situação Cadastral Regular",
"descricao": "Situação cadastral do CPF deve ser REGULAR",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.antecedentes.RegraAntecedente",
"nome": "Antecedentes Criminais",
"descricao": "Não deve constar antecedentes criminais",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraObito",
"nome": "Registro de óbito na Receita Federal",
"descricao": "Não deve constar registro de óbito na Receita Federal",
"resultado": "VALID"
}
],
"validado_em": "2018-09-19T19:34:46.815Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2018-11-19T18:39:01.841Z",
"mensagem": "Inválido. Imagem ilegível.",
"nome": "ocr_cnh",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.RegraValidacaoDocumentos",
"nome": "Validação de Imagem",
"descricao": "Verifica se o status do processamento da imagem foi concluído com sucesso",
"resultado": "INVALID",
"mensagem": "Imagem ilegível."
}
],
"validado_em": "2018-09-19T14:11:28.499Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
O resultado retornado por esta rota varia conforme a matriz que é utilizada no momento da criação do relatório.
Após a validação manual do relatório, o campo "resultado" é alterado:
Em casos de validação manual Aprovado:
"resultado": "MANUAL_APPROVAL"
Em casos de validação manual Reprovado:
"resultado": "MANUAL_REPROVAL"
Exemplo de erro
{
"error": "Unauthorized",
"message": "Falha na autenticação. Por favor verifique o token utilizado e se o acesso foi liberado.",
"status_code": 401
}
{
"error": "Not Found",
"message": "Protocolo não encontrado.",
"status_code": 404
}
Exemplos retorno de fontes
Abaixo exemplos de retorno da Receita Federal
{
"result": {
"atualizado_em": "2020-11-27T01:40:31.595Z",
"mensagem": "mensagem de retorno do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "VALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.cpf.RegraFuzzyNomeReceitaFederal",
"nome": "Nome na Receita Federal (Por semelhança)",
"descricao": "Nome deve ser similar ao cadastrado na Receita Federal",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraObito",
"nome": "Registro de óbito na Receita Federal",
"descricao": "Não deve constar registro de óbito na Receita Federal",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
"nome": "Situação Cadastral Regular",
"descricao": "Situação cadastral do CPF deve ser REGULAR",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraDataNascimento",
"nome": "Data de Nascimento na Receita Federal",
"descricao": "Data de Nascimento deve ser igual ao cadastrado na Receita Federal",
"resultado": "VALID"
}
]
"validado_em": "2018-09-19T19:34:46.815Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2020-11-27T01:40:31.595Z",
"mensagem": "mensagem de retorno do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.cpf.RegraFuzzyNomeReceitaFederal",
"nome": "Nome na Receita Federal (Por semelhança)",
"descricao": "Nome deve ser similar ao cadastrado na Receita Federal",
"resultado": "INVALID",
"mensagem": "[INVALID] Nome diferente do cadastrado na Receita Federal."
},
{
"regra": "idwall.matrix.regras.cpf.RegraObito",
"nome": "Registro de óbito na Receita Federal",
"descricao": "Não deve constar registro de óbito na Receita Federal",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
"nome": "Situação Cadastral Regular",
"descricao": "Situação cadastral do CPF deve ser REGULAR",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.cpf.RegraDataNascimento",
"nome": "Data de Nascimento na Receita Federal",
"descricao": "Data de Nascimento deve ser igual ao cadastrado na Receita Federal",
"resultado": "VALID"
}
]
"validado_em": "2018-09-19T19:34:46.815Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2020-11-26T18:15:42.059Z",
"mensagem": "Mensagem de retorno final do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.cpf.RegraObito",
"nome": "Registro de óbito na Receita Federal",
"descricao": "Não deve constar registro de óbito na Receita Federal",
"resultado": "ERROR",
"mensagem": "[ERROR] Não foi possível validar: CPF não encontrado na base de dados da Secretaria da Receita Federal do Brasil."
},
{
"regra": "idwall.matrix.regras.cpf.RegraFuzzyNomeReceitaFederal",
"nome": "Nome na Receita Federal (Por semelhança)",
"descricao": "Nome deve ser similar ao cadastrado na Receita Federal",
"resultado": "ERROR",
"mensagem": "[ERROR] Não foi possível validar: CPF não encontrado na base de dados da Secretaria da Receita Federal do Brasil."
},
{
"regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
"nome": "Situação Cadastral Regular",
"descricao": "Situação cadastral do CPF deve ser REGULAR",
"resultado": "ERROR",
"mensagem": "[ERROR] Não foi possível validar: CPF não encontrado na base de dados da Secretaria da Receita Federal do Brasil."
},
{
"regra": "idwall.matrix.regras.cpf.RegraDataNascimento",
"nome": "Data de Nascimento na Receita Federal",
"descricao": "Data de Nascimento deve ser igual ao cadastrado na Receita Federal",
"resultado": "INVALID",
"mensagem": "[INVALID] Não foi possível validar: CPF não encontrado na base de dados da Secretaria da Receita Federal do Brasil."
}
],
"validado_em": "2020-11-26T17:50:17.033Z",
"validado_manualmente": false,
"validado_por": "null"
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2019-03-12T11:30:07.423Z",
"mensagem": "Mensagem de retorno final do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.cpf.RegraObito",
"nome": "Registro de óbito na Receita Federal",
"descricao": "Não deve constar registro de óbito na Receita Federal",
"resultado": "ERROR",
"mensagem": "[ERROR] Não foi possível validar: Data de nascimento informada está divergente da constante na base de dados da Secretaria da Receita Federal do Brasil."
},
{
"regra": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal",
"nome": "Situação Cadastral Regular",
"descricao": "Situação cadastral do CPF deve ser REGULAR",
"resultado": "ERROR",
"mensagem": "[ERROR] Não foi possível validar: Data de nascimento informada está divergente da constante na base de dados da Secretaria da Receita Federal do Brasil."
},
{
"regra": "idwall.matrix.regras.cpf.RegraDataNascimento",
"nome": "Data de Nascimento na Receita Federal",
"descricao": "Data de Nascimento deve ser igual ao cadastrado na Receita Federal",
"resultado": "INVALID",
"mensagem": "[INVALID] Não foi possível validar: Data de nascimento informada está divergente da constante na base de dados da Secretaria da Receita Federal do Brasil."
}
],
"validado_em": "2019-03-12T11:30:04.858Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
Abaixo exemplos de retorno da SERPRO
{
"result": {
"atualizado_em": "2020-01-04T17:58:32.271Z",
"mensagem": "Mensagem de retorno final do relatório.",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "VALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.serpro.RegraSerproBiometriaFacial",
"nome": "Serpro biometria facial",
"descricao": "Verifica se a foto enviada é da mesma pessoa que consta na base do Serpro para o CPF informado.",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.serpro.RegraSerproCnh",
"nome": "Serpro CNH",
"descricao": "Verifica se os dados enviados são semelhantes aos que constam na base do Serpro para o CPF informado.",
"resultado": "VALID"
}
],
"validado_em": "2020-01-04T17:58:29.646Z",
"validado_manualmente": false,
"validado_por": null
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2019-12-18T16:05:43.024Z",
"mensagem": "Mensagem de retorno final do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.serpro.RegraSerproBiometriaFacial",
"nome": "Serpro biometria facial",
"descricao": "Verifica se a foto enviada é da mesma pessoa que consta na base do Serpro para o CPF informado.",
"resultado": "VALID"
},
{
"regra": "idwall.matrix.regras.serpro.RegraSerproCnh",
"nome": "Serpro CNH",
"descricao": "Verifica se os dados enviados são semelhantes aos que constam na base do Serpro para o CPF informado.",
"resultado": "INVALID",
"mensagem": "[INVALID] Campo(s) não confere(em): Nome."
},
],
"validado_em": "2019-12-18T16:05:43.006Z",
"validado_manualmente": true,
"validado_por": null
},
"status_code": 200
}
{
"result": {
"atualizado_em": "2019-12-18T16:05:43.024Z",
"mensagem": "Mensagem de retorno final do relatório",
"nome": "nome_matriz",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "INVALID",
"status": "CONCLUIDO",
"validacoes": [
{
"regra": "idwall.matrix.regras.serpro.RegraSerproBiometriaFacial",
"nome": "Serpro biometria facial",
"descricao": "Verifica se a foto enviada é da mesma pessoa que consta na base do Serpro para o CPF informado.",
"resultado": "INVALID",
"mensagem": "[INVALID] Não foi possível validar. Biometria facial não disponível para o CPF informado."
},
{
"regra": "idwall.matrix.regras.serpro.RegraSerproCnh",
"nome": "Serpro CNH",
"descricao": "Verifica se os dados enviados são semelhantes aos que constam na base do Serpro para o CPF informado.",
"resultado": "INVALID",
"mensagem": "[INVALID] Não foi possível validar o(s) campo(s): RG, Orgão expedidor do RG, Estado de expedição do RG, Nome da mãe, Nome do pai."
}
],
"validado_em": "2019-12-18T16:05:43.006Z",
"validado_manualmente": true,
"validado_por": null
},
"status_code": 200
}
Updated about 3 years ago
What’s Next