Solicitando Verificações e Background Check

Este é um recurso assíncrono. Ao fazer uma requisição, você receberá um número de protocolo que será enviado para uma fila de processamento (em ambiente de testes, esta fila é compartilhada).

Após todas as consultas e verificações serem realizadas, os dados da pessoa ou empresa são atualizados, o endpoint webhook é atualizado e o resultado da validação é disponibilizado.

Confira no diagrama abaixo como funciona o processo:

_images/fluxo-assincrono-api.min.png

Veja mais sobre as Matrizes de decisão.

POST novo protocolo de consulta

Cria um novo protocolo IDwall e inicia a validação da matriz de decisão. Os parâmetros de entrada variam de acordo com a matriz. Exexmplo de chamada na matriz consultaCPF:

Endpoint

POST https://api.idwall.co/protocolos/novo/{matriz}

Exemplo

REQUEST

POST /protocolos/novo/consultaPessoaDefault HTTP/1.1
Host: https://api.idwall.co
Authorization: teste09895HATnuv91wj1P1W4oWARXV5KW
Content-Type: application/json

{
  "cpf":"38306446046",
  "dataDeNascimento": "13/04/1989",
  "nome":"Luiz Henrique de Souza Pinto"
}

RESPONSE

A resposta será uma mensagem acompanhada do número do protocolo gerado.

{
  "message": "Consulta enviada",
  "numero": "760c0cb2-1a2b-4a22-8b13-0e4c99a72b2f",
}

Atributos do Protocolo

Nome Formato Descrição
entidadeTipo string Tipo da entidade: “pessoa” | “empresa”
entidadeId string CPF para tipo “pessoa” ou CNPJ para tipo “empresa”
situacao string Status do protocolo: “PENDENTE” | “PROCESSANDO” | “CONCLUIDO”
matriz string Nome da matriz de decisão
numero string Número de protocolo
criadoEm string Data de criação do protocolo
atualizadoEm string Data de criação do protocolo
parametros string Parâmetros de input para a resolução da matriz
> cpf string Número de CPF sem dígitos
> nome string Nome completo da pessoa
> dataDeNascimento string Data de Nascimento no formato dd/mm/yyyy
> sexo string Sexo: “M” | “F”
> estadoCivil string Estado Civil
> nomeDaMae string Nome completo da mãe da pessoa
> nomeDoPai string Nome completo do pai da pessoa
> rg string RG sem dígito
> digitoRg string Dígito do RG
> dataDeExpedicaoRg string Data de expedição do RG no formato dd/mm/yyyy
> estadoExpedicaoRg string Estado (UF) de expedição do RG
> estado string Estado (UF)
> cidade string Cidade
> bairro string Bairro
> endereco string Logradouro
> numeroDoEndereco string Número
> complementoDoEndereco string Complemento do endereço
> cep string CEP
> cnh string Número de Registro da CNH
> segurancaCnh string Número de segurança da CNH
> placa string Placa do carro, sem traço
> renavam string Número do Renavam, somente dígitos
> estadosConsultas string Lista de estados nos quais deve ser realizada a consulta de processos

GET Consultar protocolo

Por meio desta API é possível consultar as informações e detalhes de um protocolo existente por número.

Endpoint

GET https://api.idwall.co/protocolos/{numero}

Exemplo

GET https://api.idwall.co/protocolos/760c0cb2-1a2b-4a22-8b13-0e4c99a72b2f

REQUEST

GET /protocolos/760c0cb2-1a2b-4a22-8b13-0e4c99a72b2f HTTP/1.1
Host: https://api.idwall.co
Authorization: teste09895HATnuv91wj1P1W4oWARXV5KW
Content-Type: application/json

RESPONSE

{
  "entidadeTipo": "pessoa",
  "entidadeId": "17723062826",
  "situacao": "PENDENTE",
  "matriz": "consultaPessoaDefault",
  "numero": "760c0cb2-1a2b-4a22-8b13-0e4c99a72b2f",
  "criadoEm": "2016-09-17T16:36:09.461Z",
  "parametros": {
    "cpf": "177.230.628-26",
    "dataDeNascimento": "25/9/1980",
    "nome": "Elmer Hanson"
  }
}

GET Listar Protocolos

Por meio desta API é possível listar todos protocolos criados anteriormente. Os pedidos são ordenados pela data de criação, dos mais recentes para os mais antigos. Os resultados são paginados. Para maiores informações, consulte Paginação.

Endpoint

GET https://api.idwall.co/protocolos/

Exemplo

REQUEST

GET /protocolos HTTP/1.1
Host: https://api.idwall.co
Authorization: teste09895HATnuv91wj1P1W4oWARXV5KW
Content-Type: application/json

RESPONSE

{
  "items": [
    {
      "entidadeTipo": "empresa",
      "situacao": "PENDENTE",
      "numero": "478751f9-4464-58e2-a49c-067ccfca8723",
      "entidadeId": "54538434000179",
      "atualizadoEm": "2076-07-21T19:59:09.601Z",
      "criadoEm": "2020-03-08T11:02:35.101Z",
      "matriz": "consultaEmpresaDefault",
      "parametros": {
        "cnpj": "54538434000179",
      }
    },
    {
      "entidadeTipo": "pessoa",
      "situacao": "CONCLUIDO",
      "numero": "968eeb19-8900-5af9-8148-fca590dc22a8",
      "entidadeId": "87266799356",
      "atualizadoEm": "2019-09-27T03:16:13.825Z",
      "criadoEm": "2024-10-07T23:54:49.304Z",
      "matriz": "consultaPessoaDefault",
      "parametros": {
        "nome": "Leah Eugenia Arnold",
        "cpf": "87266799356",
        "dataDeNascimento": "18/09/2014",
      }
    }
  ],
  "nextPageToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9"
}

Atributos do retorno

Nome Descrição Detalhes
items Coleção de protocolos string
nextPageToken Token de paginação string

GET Listar fontes por protocolo

Retorna a lista de todas as fontes consultadas para processar um protocolo. Para a lista de fontes veja Fontes de consulta.

Endpoint

GET https://api.idwall.co/protocolos/{numero}/consultas

Exemplo

REQUEST

GET /protocolos/968eeb19-8900-5af9-8148-fca590dc22a8/consultas HTTP/1.1
Host: https://api.idwall.co
Authorization: teste09895HATnuv91wj1P1W4oWARXV5KW
Content-Type: application/json

RESPONSE

{
  "items": [
    {
      "name": "AntecedentesPoliciaCivilSP",
      "numero": "fc450c40-2c5f-5fed-a359-b782388610e5",
      "status": "PENDENTE",
      "successes": [],
      "fails": [],
      "criadoEm": "2016-09-16T21:09:11.818Z",
    },
    {
      "name": "AntecedentesPoliciaFederal",
      "numero": "fc450c40-2c5f-5fed-a359-b782388610e5",
      "status": "CONCLUIDO",
      "successes": [
        "2042-10-28T05:22:00.433Z",
        "2112-09-07T16:47:27.230Z"
      ],
      "fails": [
        "2059-01-08T23:49:01.678Z",
      ],
      "criadoEm": "2016-09-16T21:09:11.818Z",
    },
    {
      "name": "VeiculoDetranSP",
      "numero": "fc450c40-2c5f-5fed-a359-b782388610e5",
      "status": "ERRO",
      "successes": [],
      "fails": [
        "2111-10-09T15:08:41.112Z",
        "2023-09-30T11:43:12.568Z",
      ],
      "criadoEm": "2016-09-16T21:09:11.816Z",
    }
  ]
}

Atributos do retorno

Nome Descrição Detalhes
items Coleção de consultas string

POST Reprocessar fonte

Por meio desta API, é enviada à fila de processamento uma nova consulta. de uma fonte específica de um protocolo.

Endpoint

GET https://api.idwall.co/protocolos/{numero}/reprocessa/{fonte}

Exemplo

REQUEST

POST /protocolos/760c0cb2-1a2b-4a22-8b13-0e4c99a72b2f/reprocessa/ReceitaFederalCPF HTTP/1.1
Host: https://api.idwall.co
Authorization: teste09895HATnuv91wj1P1W4oWARXV5KW
Content-Type: application/json

RESPONSE

{
  "message": "Socilitação de reprocessamento enviada"
}