Dados
Como obter os dados de um relatório ?
Para obter todos os dados de um relatório anteriormente criado, basta realizar uma simples requisição com o método GET para nossa API no seguinte endpoint:https://api-v2.idwall.co/relatorios/{numero_do_relatorio}/dadossubstituindo 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_relatorio/dados
-H "Content-Type: application/json"
-H 'Authorization:seu-token'
Exemplo de sucesso
{
"result": {
"atualizado_em": "2018-11-19T19:39:43.565Z",
"criado_em": "2018-11-19T19:34:46.515Z",
"mensagem": "Válido.",
"nome": "consultaPessoaDefault",
"numero": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"resultado": "VALID",
"status": "CONCLUIDO",
"validado_em": "2018-11-19T19:34:46.815Z",
"validado_manualmente": false,
"certidoes_negativas": {
"itens": [
{
"emitido_em": "2018-11-19T19:34:51.392971Z",
"fonte": "AntecedentesPoliciaFederal",
"protocolo": "46729702018",
"url": null,
"nada_consta": true
}
]
},
"cpf": {
"numero": "70195619700",
"nome": "Minerva McGonagall",
"data_de_nascimento": "04-10-1935",
"cpf_situacao_cadastral": "REGULAR",
"cpf_data_de_inscricao": "17-05-1965",
"cpf_digito_verificador": "00",
"cpf_anterior_1990": "S",
"ano_obito": "",
"grafias": [
"MINERVA MCGONAGALL"
]
},
"processos": {
"itens": []
},
"protestos": {
"estados_sem_protestos": [
"TO",
"SE",
"SP",
"SC",
"RR",
"RO",
"RS",
"RN",
"RJ",
"PI",
"PE",
"PR",
"PB",
"PA",
"MG",
"MS",
"MT",
"MA",
"GO",
"ES",
"DF",
"CE",
"BA",
"AM",
"AP",
"AL",
"AC"
]
}
},
"status_code": 200
}
Caso alguma chave venha com o valor nulo ou vazio significa que a fonte não retornou nenhum valor para aquele dado em específico.
O resultado retornado por esta rota varia conforme a matriz que é utilizada no momento da criação do relatório.
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
}
Exemplo de retornos de fontes
Exemplos de retorno da Receita Federal
"cpf": {
"numero": "xxx.xxx.xxx-xx",
"nome": "Nome da Pessoa",
"data_de_nascimento": "dd/mm/YYYY",
"cpf_situacao_cadastral": "REGULAR",
"cpf_data_de_inscricao": "anterior a 10/11/1990",
"cpf_digito_verificador": "00",
"cpf_anterior_1990": "S",
"ano_obito": "",
"grafias": [
"NOME DA PESSOA"
]
}
"cpf": {
"numero": null,
"nome": null,
"data_de_nascimento": null,
"cpf_situacao_cadastral": null,
"cpf_data_de_inscricao": null,
"cpf_digito_verificador": null,
"cpf_anterior_1990": null,
"ano_obito": null,
"grafias": [
null
]
}
Exemplos de retorno do SERPRO
"serpro_datavalid": {
"dados": {
"cnh": {},
"nome": true,
"request": {
"key": {
"cpf": "xxxxxxxxxxx"
},
"answer": {
"nome": "Nome da pessoa",
"filiacao": {
"nomeMae": "Nome da mae da pessoa"
},
"biometriaFace": "URL_da_imagem",
"dataNascimento": "YYYY-mm-dd"
}
},
"endereco": {},
"filiacao": {
"nome_mae": true,
"nome_mae_similaridade": 1
},
"documento": {},
"biometria_face": {
"disponivel": true,
"similaridade": 0.9779243472433352,
"probabilidade": "Altíssima probabilidade"
},
"cpf_disponivel": true,
"data_nascimento": true,
"nome_similaridade": 0.6764705882352942
}
}
"serpro_datavalid": {
"dados": {
"cnh": {},
"nome": false,
"request": {
"key": {
"cpf": "xxxxxxxxxxx"
},
"answer": {
"nome": "Nome da pessoa",
"filiacao": {
"nomeMae": "Nome da mae da pessoa"
},
"biometriaFace": "URL_da_imagem",
"dataNascimento": "YYYY-mm-dd"
}
},
"endereco": {},
"filiacao": {
"nome_mae": true,
"nome_mae_similaridade": 1
},
"documento": {},
"biometria_face": {
"disponivel": true,
"similaridade": 0.9779243472433352,
"probabilidade": "Altíssima probabilidade"
},
"cpf_disponivel": true,
"data_nascimento": true,
"nome_similaridade": 0.6764705882352942
}
}
"serpro_datavalid": {
"dados": {
"cnh": {},
"nome": false,
"request": {
"key": {
"cpf": "xxxxxxxxxxx"
},
"answer": {
"nome": "Nome da pessoa",
"filiacao": {
"nomeMae": "Nome da mae da pessoa"
},
"biometriaFace": "URL_da_imagem",
"dataNascimento": "YYYY-mm-dd"
}
},
"endereco": {},
"filiacao": {
"nome_mae": true,
"nome_mae_similaridade": 1
},
"documento": {},
"biometria_face": {
"disponivel": false
},
"cpf_disponivel": true,
"data_nascimento": true,
"nome_similaridade": 0.6764705882352942
}
}
Updated about 4 years ago
What’s Next