🇧🇷 Resumen

En esta sección, encontrarás información sobre los datos de entrada requeridos para el perfil de una persona en Brasil, los reportes disponibles, la configuración de reportes y cómo realizar consultas para crear una persona, obtener el estado de una persona y los detalles de sus reportes.

¿Has leído nuestra introducción?

Esta sección contiene los detalles específicos sobre el perfil de entrada y los reportes disponibles en Brasil. Para entenderlo mejor, te recomendamos que también eches un vistazo a nuestra sección de Primeros Pasos. 😊

Perfil

Campo de entrada	Descripción	Ejemplo
city_locode	El UN LOCODE de la ciudad donde se encuentra la persona (u otra ciudad según tus necesidades para dirigir el proceso de BGC). Siempre requerido.	BR CWB
document_id	Número de ID del Documento para Brasil. Dígitos del Cadastro de Pessoa Física (CPF).	000.000.000-00
document_id_alt	Número de ID del Documento Alternativo para Brasil. Número del Registro Geral (RG).	00000000
dob	Representación ISO 8601 de la fecha en que nació la persona.	1985-08-13
full_name	Nombre Completo de la persona a verificar.	ANTONIO DOE
mothers_full_name	Nombre Completo de la madre de la Persona. Campo opcional. Si se proporciona, se usa para verificación de homónimos.	JANE DOE
fathers_full_name	Nombre Completo del padre de la Persona. Campo opcional. Si se proporciona, se usa para verificación de homónimos.	RICHARD ROE

Reportes disponibles

Nombre del reporte	Descripción	Fuente/base de datos
cpf_status	Valida un número de CPF (document_id) y recupera los datos personales de la base de datos de Receita Federal.	Receita Federal
name_check	Verifica el full_name proporcionado contra el full_name registrado en la base de datos de Receita Federal.	Receita Federal
dob_check	Verifica la dob proporcionada contra la dob registrada en la base de datos de Receita Federal.	Receita Federal
national_criminal_record	Valida datos personales y verifica Tribunales Federales y Estatales a nivel nacional según criterios del cliente.	Receita Federal, Poder Judiciário do Brasil.

¿Quieres entrar en acción?

¡Consulta nuestra sección de Referencia de API y comienza a usarla de inmediato! 😄

Configuración de reportes

El objeto report_settings es el lugar para personalizar comportamientos específicos de los reportes disponibles. En Brasil, el reporte name_check puede personalizarse para determinar la mejor regla para tu pipeline de usuarios/candidatos según los datos que tengas disponibles de ellos.

Reporte Name Check

Hay dos configuraciones disponibles para el reporte name_check:

1. name_score_min: Este es un número flotante que va de 0 a 1, considerando hasta dos decimales. Determina la puntuación mínima requerida para el full_name proporcionado para devolver un resultado PASSED. El valor predeterminado es 1 (100%). Ejemplo: si name_score_min=0.98, significa que el full_name proporcionado necesita tener al menos 98% de similitud con el full_name asociado con el document_id (cuando name_fragment_check no está habilitado).
2. name_fragment_check: Este es un valor booleano (ya sea True o False) que determinará si la puntuación debe calcularse mediante una comparación directa de todo el full_name proporcionado contra el full_name encontrado en la base de datos para el document_id. Cuando se establece en False, la score será el resultado de una comparación de cadenas entre el full_name proporcionado y el full_name encontrado en la base de datos del document_id. Si se establece en True, la puntuación será el promedio de las puntuaciones de cada fragmento del full_name proporcionado, donde la puntuación de cada fragmento es la puntuación más alta para cada fragmento del full_name de entrada de las comparaciones con cada fragmento del full_name encontrado en la base de datos del document_id. El valor predeterminado es False).

Consejos de Emptorite 🕵️‍♀️

Cómo calcular la puntuación con name_fragment_check

Nombre Completo de Entrada: JUAN DOE Nombre Completo del ID del Documento: JUAN ANTONIO DOE

Paso 1:

Obtener las puntuaciones entre la comparación entre cada fragmento del Nombre Completo de Entrada y cada fragmento del Nombre Completo del ID del Documento.

1er fragmento (JUAN): JUAN x JUAN: 1.0 JUAN x ANTONIO: 0.36 JUAN x DOE: 0.0 Valor más alto: 1.0

---

2do fragmento (DOE): DOE x JUAN: 0.0 DOE x ANTONIO: 0.2 DOE x DOE: 1.0 Valor más alto: 1.0

---

Paso 2:

Obtener la puntuación para cada fragmento del full_name proporcionado de la puntuación más alta para cada fragmento calculado en el paso anterior:

Puntuación del 1er fragmento (JUAN): 1.0 Puntuación del 2do fragmento (DOE): 1.0

---

Paso 3:

Obtener la score final mediante el promedio entre las puntuaciones de cada fragmento:

Puntuación del 1er fragmento (JUAN) + Puntuación del 2do fragmento (DOE) / 2 => 1.0 + 1.0 / 2 => 2/2 = 1.0

---

Puntuación final: 1.0

Solicitudes de ejemplo

Crear una Persona

Para crear una persona, copia y pega el siguiente comando o código, reemplazando los datos ficticios con los datos de la persona que quieres usar y la cadena YOUR_API_KEY con tu Clave 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)

Obtener el estado de la persona

Para obtener el estado de una persona, necesitarás el person_id devuelto por nuestra API en el paso Crear una Persona. Úsalo con tu Clave API dentro del siguiente comando o código (en el ejemplo a continuación, el person_id es 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)

Obtener detalles de reportes

Para obtener los detalles de los reportes de la persona, necesitarás el person_id devuelto en el paso Crear una Persona. Úsalo con tu Clave API dentro del siguiente comando o código (en el ejemplo a continuación, el person_id es 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)

Cómo obtener una Clave API

La Clave API es el token que necesitarás para autenticarte en nuestros sistemas. Si aún necesitas obtener una, por favor contáctanos.