Descripción

El servicio de antecedentes de Brasil proporciona información detallada sobre individuos brasileños. Al realizar una consulta, la respuesta incluye datos relevantes como nombres asociados, capacidad para emitir informes, número de certificación, número de documento, tipo de documento, primer nombre, nombre completo, apellido, y un archivo PDF codificado en base64.

Para hacer uso de este servicio en una interfaz gráfica te invitamos a ingresar a nuestro client panel de Verifik.

Parámetros

Nombre Tipo ¿Requerido? Descripción Ejemplo
documentType String True Tipo de documento. Valor permitido: CPF. CPF
documentNumber String True Número de documento de la persona a consultar. 123456789
dateOfBirth String True Fecha de nacimiento de la persona a consultar, formato correcto: dd/mm/yyyy. 20/05/2022

Implementación

Consulta

import axios from 'axios';

const options = {
  method: 'GET',
  url: '<https://api.verifik.co/v2/br/background-check>',
  params: {
    documentType: 'CPF',
    documentNumber: '012.345.678-01',
    dateOfBirth: '17/02/2002'
  },
  headers: {
    Accept: 'application/json',
    Authorization: 'jwt <tu_token>'
  }
};

try {
 notFou const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

Respuesta 200 - (Consulta exitosa)

{
    "data": {
        "arrayName": [
            "MATEO",
            "VERIFIK"
        ],
        "canIssue": "true",
        "certificationNumber": "036386572024",
        "dateOfBirth": "2002-02-17",
        "documentNumber": "01234567801",
        "documentType": "CPF",
        "firstName": "MATEO",
        "fullName": "MATEO VERIFIK",
        "lastName": "VERIFIK",
        "pdfUrl": "<https://cdn.verifik.co/background-check/brazilian/pdf/170920125876-application.pdf>"
    },
    "signature": {
        "dateTime": "July 24, 2024 9:29 PM",
        "message": "Certified by Verifik.co"
    },
    "id": "TI20Z"
}

Otras respuestas

Code Descripción Response Body
404 Not Found Información no encontrada {
"code": "NotFound",
"message": "Record not found.",
"signature": {
"dateTime": "August 31, 2022 3:24 PM",
"message": "Certified by Verifik.co"
}
}
409 Conflict Hace falta suministrar algún parámetro. {
"code": "MissingParameter",
"message": "missing documentType\n. missing documentNumber\n. missing dateOfBirth\n"
}
409 Conflict documentType inválido para esta consulta. {
"code": "MissingParameter",
"message": "documentType must be one of: [CPF]"
}
409 Conflict Formato de fecha inválido. {
"code": "MissingParameter",
"message": "dateOfBirth format required: DD/MM/YYYY\n"
}