The Brazil Background service provides detailed information about Brazilian individuals. When making a query, the response includes relevant data such as associated names, ability to issue reports, certification number, document number, document type, first name, full name, last name, and a base64-encoded PDF file.

Parameters

Name Type ¿Required? Description Example
documentType String True Document type. Valid parameter: CPF. CPF
documentNumber String True Document number of the person to consult. 123456789
dateOfBirth String True Date of birth of the person to consult, valid format: dd/mm/yyyy. 20/05/2022

Implementation

Request

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);
}

Response 200 - (Successful response)

{
    "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/170920571123876-application.pdf>"
    },
    "signature": {
        "dateTime": "July 25, 2024 3:24 PM",
        "message": "Certified by Verifik.co"
    },
    "id": "8UX8S"
}

Other responses

Code Description Response Body
404 Not Found Information not found. {
"code": "NotFound",
"message": "Record not found.",
"signature": {
"dateTime": "August 31, 2022 3:24 PM",
"message": "Certified by Verifik.co"
}
}
409 Conflict Some parameters are missing. {
"code": "MissingParameter",
"message": "missing documentType\n. missing documentNumber\n. missing dateOfBirth\n"
}
409 Conflict Invalid documentType for this query. {
"code": "MissingParameter",
"message": "documentType must be one of: [CPF]"
}
409 Conflict Invalid date format. {
"code": "MissingParameter",
"message": "dateOfBirth format required: DD/MM/YYYY\n"
}