Bem vindo a documentação da IDwall

Aqui você vai encontrar tudo que precisa para integrar o seu sistema com a nossa API

Start here!
Suggest Edits

Create a new report

Use this procedure to create a new Report, sending the data of a person (natural or legal)

 
posthttps://api-v2.idwall.co/relatorios

Body Params

matriz
string

ex: consultaPessoaDefault

parametros
object
 
parametros.cpf_nome
string

ex: Gabriel Massote Prado

parametros.cpf_numero
string

ex: 076.149.176-77

parametros.cpf_data_de_nascimento
string

ex: 25/05/1987

 
curl --request POST \
  --url https://api-v2.idwall.co/relatorios
var request = require("request");

var options = { method: 'POST', url: 'https://api-v2.idwall.co/relatorios' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api-v2.idwall.co/relatorios")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api-v2.idwall.co/relatorios");

xhr.send(data);
import requests

url = "https://api-v2.idwall.co/relatorios"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "numero": "766b2980-1559-43cd-a8eb-bd6bc807e722"
    },
    "status_code": 200
}
 
Suggest Edits

Get report status

Use this method to get the basic information of a Report by sending its protocol number

 
gethttps://api-v2.idwall.co/relatorios/report_id

Path Params

report_id
string
required

ex: 32144edb-f338-4f2c-a065-1096e617a4df

The API will return a JSON with information from the Report

For a better understanding of the Report’s status , read the Report Status article.

Each time a query to one of the external sources of a Report is completed, the atualizado_em (updated_on) key has its value updated.

The resultado (result) key provides the final validation of a Report. The VALID value indicates that the person analyzed met all the requirements of the Report, while the INVALID value indicates that one or more inputs must be reviewed.

The mensagem (message) key brings additional information about the report.

curl --request GET \
  --url https://api-v2.idwall.co/relatorios/report_id
var request = require("request");

var options = { method: 'GET',
  url: 'https://api-v2.idwall.co/relatorios/report_id' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api-v2.idwall.co/relatorios/report_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api-v2.idwall.co/relatorios/report_id");

xhr.send(data);
import requests

url = "https://api-v2.idwall.co/relatorios/report_id"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "status_code": 200,
    "result": {
        "numero": "99988855-0000-aaaa-abcd-123456789012",
        "nome": "consultaPessoaDefault", //tipo de Relatório
      	"status": "CONCLUIDO",
        "atualizado_em": "2017-03-20T17:49:20.000Z",    
        "resultado": "VALID"
    }
}
 
Suggest Edits

Get status for IDwall API

 
gethttps://api-v2.idwall.co/status
 
curl --request GET \
  --url https://api-v2.idwall.co/status
var request = require("request");

var options = { method: 'GET', url: 'https://api-v2.idwall.co/status' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api-v2.idwall.co/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api-v2.idwall.co/status");

xhr.send(data);
import requests

url = "https://api-v2.idwall.co/status"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "result": {
        "ambiente": "production",
        "ref": "production",
        "versao": "production"
    },
    "status_code": 200
}