🇧🇷 Brasil

Nesta seção, você encontrará informações sobre os dados de entrada necessários para o perfil de uma pessoa no Brasil, os relatórios disponíveis, as configurações dos relatórios e como realizar consultas para criar uma pessoa, obter o status de uma pessoa e os detalhes de seus relatórios.

Você leu nossa introdução?

Esta seção contém as especificidades sobre o perfil de entrada e os relatórios disponíveis no Brasil. Para entendê-la melhor, recomendamos que você dê uma olhada em nossa seção Primeiros Passos também. 😊

Perfil

Campo de entrada	Descrição	Exemplo
city_locode	O UN LOCODE da cidade onde a pessoa está localizada (ou outra cidade de acordo com suas necessidades para direcionar o processo de BGC). Sempre obrigatório.	BR CWB
document_id	Número do Documento de Identidade para o Brasil. Dígitos do Cadastro de Pessoa Física (CPF).	000.000.000-00
document_id_alt	Número Alternativo do Documento de Identidade para o Brasil. Número do Registro Geral (RG).	00000000
dob	Representação ISO 8601 da data em que a pessoa nasceu.	1985-08-13
full_name	Nome Completo da pessoa a ser verificada.	ANTONIO DOE
mothers_full_name	Nome Completo da mãe da pessoa. Campo opcional. Se fornecido, é usado para verificação de homônimos.	JANE DOE
fathers_full_name	Nome Completo do pai da pessoa. Campo opcional. Se fornecido, é usado para verificação de homônimos.	RICHARD ROE

Relatórios disponíveis

Nome do relatório	Descrição	Fonte/banco de dados
cpf_status	Valida um número de CPF (document_id) e recupera os dados pessoais do banco de dados da Receita Federal.	Receita Federal
name_check	Verifica o full_name fornecido contra o full_name registrado no banco de dados da Receita Federal.	Receita Federal
dob_check	Verifica a dob fornecida contra a dob registrada no banco de dados da Receita Federal.	Receita Federal
national_criminal_record	Valida dados pessoais e verifica Tribunais Federais e Estaduais em todo o país de acordo com os critérios do cliente.	Receita Federal, Poder Judiciário do Brasil.

Quer partir para a ação?

Confira nossa seção Referência da API e comece a usá-la imediatamente! 😄

Configurações de relatório

O objeto report_settings é o lugar para você personalizar comportamentos específicos dos relatórios disponíveis. No Brasil, o relatório name_check pode ser personalizado para determinar a melhor regra para o pipeline de seus usuários/candidatos de acordo com os dados que você tem disponíveis deles.

Relatório Name Check

Existem duas configurações disponíveis para o relatório name_check:

1. name_score_min: Este é um número decimal que varia de 0 a 1, considerando até duas casas decimais. Determina a pontuação mínima necessária para o full_name fornecido para retornar um resultado PASSED. O valor padrão é 1 (100%). Exemplo: se name_score_min=0.98, significa que o full_name fornecido precisa ter pelo menos 98% de similaridade com o full_name associado ao document_id (quando name_fragment_check não está habilitado).
2. name_fragment_check: Este é um valor booleano (seja True ou False) que determinará se a pontuação deve ser calculada por uma comparação direta de todo o full_name fornecido contra o full_name encontrado no banco de dados para o document_id. Quando definido como False, a score será o resultado de uma comparação de string entre o full_name fornecido e o full_name encontrado no banco de dados do document_id. Se definido como True, a pontuação será a média das pontuações de cada fragmento do full_name fornecido, onde a pontuação de cada fragmento é a pontuação mais alta para cada fragmento do full_name de entrada das comparações com cada fragmento do full_name encontrado no banco de dados do document_id. O valor padrão é False).

Dicas Emptorite 🕵️‍♀️

Como calcular a pontuação com name_fragment_check

Nome Completo de Entrada: JUAN DOE Nome Completo do Document ID: JUAN ANTONIO DOE

Passo 1:

Obtenha as pontuações entre a comparação de cada fragmento do Nome Completo de Entrada e cada fragmento do Nome Completo do Document ID.

1º fragmento (JUAN): JUAN x JUAN: 1.0 JUAN x ANTONIO: 0.36 JUAN x DOE: 0.0 Valor mais alto: 1.0

---

2º fragmento (DOE): DOE x JUAN: 0.0 DOE x ANTONIO: 0.2 DOE x DOE: 1.0 Valor mais alto: 1.0

---

Passo 2:

Obtenha a pontuação para cada fragmento do full_name fornecido a partir da pontuação mais alta para cada fragmento calculado no passo anterior:

1º fragmento (JUAN) pontuação: 1.0 2º fragmento (DOE) pontuação: 1.0

---

Passo 3:

Obtenha a score final pela média entre as pontuações de cada fragmento:

1º fragmento (JUAN) pontuação + 2º fragmento (DOE) pontuação / 2 => 1.0 + 1.0 / 2 => 2/2 = 1.0

---

Pontuação final: 1.0

Exemplos de requisições

Criar uma Pessoa

Para criar uma pessoa, copie e cole o seguinte comando ou código, substituindo os dados fictícios pelos dados da pessoa que você deseja usar e a string YOUR_API_KEY pela sua Chave da API, respectivamente:

curl --request POST \
  --url https://api.emptor.io/v3/br/persons/ \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"reports":{"national_criminal_record":"enabled"},"city_locode":"BR CWB","document_id":"000.000.000-00","document_id_alt":"00000000","dob":"1985-08-13","full_name":"ANTONIO DOE","mothers_full_name":"JANE DOE","fathers_full_name":"RICHARD ROE"}'

const fetch = require('node-fetch');

let url = 'https://api.emptor.io/v3/br/persons/';

let options = {
  method: 'POST',
  headers: {Accept: 'application/json', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    reports: {national_criminal_record: 'enabled'},
    city_locode: 'BR CWB',
    document_id: '000.000.000-00',
    document_id_alt: '00000000',
    dob: '1985-08-13',
    full_name: 'ANTONIO DOE',
    mothers_full_name: 'JANE DOE',
    fathers_full_name: 'RICHARD ROE'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.emptor.io/v3/br/persons/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Post.new(url)
request["Accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request.body = "{\"reports\":{\"national_criminal_record\":\"enabled\"},\"city_locode\":\"BR CWB\",\"document_id\":\"000.000.000-00\",\"document_id_alt\":\"00000000\",\"dob\":\"1985-08-13\",\"full_name\":\"ANTONIO DOE\",\"mothers_full_name\":\"JANE DOE\",\"fathers_full_name\":\"RICHARD ROE\"}"

response = http.request(request)
puts response.read_body

import requests

url = "https://api.emptor.io/v3/br/persons/"

payload = {
    "reports": {"national_criminal_record": "enabled"},
    "city_locode": "BR CWB",
    "document_id": "000.000.000-00",
    "document_id_alt": "00000000",
    "dob": "1985-08-13",
    "full_name": "ANTONIO DOE",
    "mothers_full_name": "JANE DOE",
    "fathers_full_name": "RICHARD ROE"
}
headers = {
    "Accept": "application/json",
    "Content-Type": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

Obter status da pessoa

Para obter o status de uma pessoa, você precisará do person_id retornado por nossa API no passo Criar uma Pessoa. Use isso com sua Chave da API dentro do seguinte comando ou código (no exemplo abaixo, o person_id é 0597f9f8-2ea5-4557-b3a1-5a590ed96ef4):

curl --request GET \
  --url https://api.emptor.io/v3/br/persons/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4/status \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

const fetch = require('node-fetch');

let url = 'https://api.emptor.io/v3/br/persons/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4/status';

let options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-Api-Key': 'YOUR_API_KEY'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.emptor.io/v3/br/persons/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["X-Api-Key"] = 'YOUR_API_KEY'

response = http.request(request)
puts response.read_body

import requests

url = "https://api.emptor.io/v3/br/persons/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4/status"

headers = {
    "Accept": "application/json",
    "X-Api-Key": "YOUR_API_KEY"
}

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

print(response.text)

Obter detalhes dos relatórios

Para obter os detalhes dos relatórios da pessoa, você precisará do person_id retornado no passo Criar uma Pessoa. Use isso com sua Chave da API dentro do seguinte comando ou código (no exemplo abaixo, o person_id é 0597f9f8-2ea5-4557-b3a1-5a590ed96ef4):

curl --request GET \
  --url https://api.emptor.io/v3/br/details/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4 \
  --header 'Accept: application/json' \
  --header 'X-Api-Key: YOUR_API_KEY'

const fetch = require('node-fetch');

let url = 'https://api.emptor.io/v3/br/details/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4';

let options = {
  method: 'GET',
  headers: {Accept: 'application/json', 'X-Api-Key': 'YOUR_API_KEY'}
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error('error:' + err));

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.emptor.io/v3/br/details/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
http.verify_mode = OpenSSL::SSL::VERIFY_NONE

request = Net::HTTP::Get.new(url)
request["Accept"] = 'application/json'
request["X-Api-Key"] = 'YOUR_API_KEY'

response = http.request(request)
puts response.read_body

import requests

url = "https://api.emptor.io/v3/br/details/0597f9f8-2ea5-4557-b3a1-5a590ed96ef4"

headers = {
    "Accept": "application/json",
    "X-Api-Key": "YOUR_API_KEY"
}

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

print(response.text)

Como obter uma Chave da API

A Chave da API é o token que você precisará para se autenticar em nossos sistemas. Se você ainda precisa obter uma, por favor entre em contato conosco.