Detalhando as configurações

Como detalhar as matrizes presentes na sua conta ?

Para detalhar uma matriz que esta cadastrada em sua conta, basta realizar uma simples requisição com o método GET para a nossa API no seguinte endpoint: https://api-v2.idwall.co/matrizes passando como parâmetro do próprio caminho o nome da matriz como mostra o exemplo abaixo.

curl -X GET https://api-v2.idwall.co/matrizes/nome_matriz 
-H "Content-Type: application/json"
-H 'Authorization:seu-token'

Exemplo de sucesso

{
  "result": {
    "descricao": null,
    "creditos": 1,
    "nome": "consultaPessoaDefault",
    "parametros": [
      {
        "nome": "cpf_data_de_nascimento",
        "requerido": true,
        "titulo": "Data de nascimento"
      },
      {
        "nome": "cpf_nome",
        "requerido": true,
        "titulo": "Nome completo"
      },
      {
        "nome": "cpf_numero",
        "requerido": true,
        "titulo": "CPF"
      }
    ],
    "regras": [
      {
        "descricao": "Não deve constar antecedentes criminais",
        "nome": "Antecedentes Criminais",
        "regras": [
          {
            "resultado": "nao_foi_possivel_emitir",
            "valor": "INVALID"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "nao_constam_antecedentes",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.antecedentes.RegraAntecedente"
      },
      {
        "descricao": "Nome deve ser igual ao cadastrado na Receita Federal",
        "nome": "Nome na Receita Federal",
        "regras": [
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "nome_como_o_da_receita_federal",
            "valor": "VALID"
          },
          {
            "resultado": "nome_diferente_da_receita_federal",
            "valor": "INVALID"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraNomeReceitaFederal"
      },
      {
        "descricao": "Não deve constar processos nos Tribunais de Justiça",
        "nome": "Processos nos Tribunais de Justiça",
        "regras": [
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "nenhum_processo_encontrado",
            "valor": "VALID"
          },
          {
            "resultado": "processo_encontrado",
            "valor": "INVALID"
          }
        ],
        "slug": "idwall.matrix.regras.processos.RegraProcessos"
      },
      {
        "descricao": "Não devem constar protestos",
        "nome": "Protestos",
        "regras": [
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "protesto_encontrado",
            "valor": "INVALID"
          },
          {
            "resultado": "nenhum_protesto_encontrado",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.protestos.RegraProtestos"
      },
      {
        "descricao": "Não deve constar registro de óbito na Receita Federal",
        "nome": "Registro de óbito na Receita Federal",
        "regras": [
          {
            "resultado": "possui_registro_de_obito",
            "valor": "INVALID"
          },
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          },
          {
            "resultado": "nao_possui_registro_de_obito",
            "valor": "VALID"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraObito"
      },
      {
        "descricao": "Situação cadastral do CPF deve ser REGULAR",
        "nome": "Situação Cadastral Regular",
        "regras": [
          {
            "resultado": "error",
            "valor": "ERROR"
          },
          {
            "resultado": "situacao_cadastral_regular",
            "valor": "VALID"
          },
          {
            "resultado": "situacao_cadastral_diferente_de_regular",
            "valor": "INVALID"
          },
          {
            "resultado": "n_a",
            "valor": "NO_DATA"
          }
        ],
        "slug": "idwall.matrix.regras.cpf.RegraSituacaoReceitaFederal"
      }
    ],
    "tipo": "Pessoa",
    "titulo": "Relatório padrão PF"
  },
  "status_code": 200
}

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": "Not Found",
  "status_code": 404
}

What’s Next