Brasil

Referência da API

Endpoint

https://api.verifik.co/v2/br/background-check

Triagem de antecedentes individual no Brasil usando CPF e data de nascimento. Uma resposta bem-sucedida inclui campos relacionados à identidade e, quando o provedor de dados o disponibiliza, um relatório PDF codificado em base64. Indicado para triagem de candidatos, due diligence e conformidade; trate o PDF e os metadados de acordo com suas próprias regras legais e de retenção.

Cabeçalhos

Nome	Valor
Accept	application/json
Authorization	Bearer <token>

Parâmetros

info

Para a lista completa de tipos de documento suportados e seus parâmetros obrigatórios específicos, consulte o guia Tipos de documento.

Nome	Tipo	Obrigatório	Descrição
documentType	string	Sim	Tipo de documento. Parâmetro permitido: CPF.
documentNumber	string	Sim	Número do documento da pessoa a ser consultada.
dateOfBirth	string	Sim	Data de nascimento da pessoa a ser consultada, formato válido: dd/mm/aaaa.

Requisição

JavaScript

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: 'Bearer <seu_token>'
  }
};

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

Python

import http.client

conn = http.client.HTTPSConnection("api.verifik.co")

headers = {
    'Accept': "application/json",
    'Authorization': "Bearer <seu_token>"
}

conn.request("GET", "/v2/br/background-check?documentType=CPF&documentNumber=012.345.678-01&dateOfBirth=17/02/2002", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.verifik.co/v2/br/background-check?documentType=CPF&documentNumber=012.345.678-01&dateOfBirth=17/02/2002', [
  'headers' => [
    'Accept' => 'application/json',
    'Authorization' => 'Bearer <seu_token>',
  ],
]);

echo $response->getBody();

Swift

import Foundation

let headers = [
  "Accept": "application/json",
  "Authorization": "Bearer <seu_token>"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.verifik.co/v2/br/background-check?documentType=CPF&documentNumber=012.345.678-01&dateOfBirth=17/02/2002")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()

Resposta

200

{
  "data": {
    "documentType": "CPF",
    "documentNumber": "012.345.678-01",
    "firstName": "João",
    "lastName": "Silva",
    "fullName": "João Silva",
    "dateOfBirth": "17/02/2002",
    "certificationNumber": "123456789",
    "canIssueReports": true,
    "associatedNames": ["João Silva Santos"],
    "pdfReport": "base64_encoded_pdf_content",
    "status": "clear"
  },
  "signature": {
    "dateTime": "April 11, 2023 12:25 PM",
    "message": "Certified by Verifik.co"
  }
}

404

{
    "code": "NotFound",
    "message": "Record not found."
}

409

{
  "code": "MissingParameter",
  "message": "missing documentType\n. missing documentNumber\n. missing dateOfBirth\n"
}

409 (Tipo inválido)

{
  "code": "MissingParameter",
  "message": "documentType must be one of: [CPF]"
}

Recursos

• Verificação de CPF: valida a autenticidade de documentos CPF brasileiros.
• Dados completos de antecedentes: retorna nome completo, detalhes do documento, número de certificação e relatório em PDF.
• Resposta estruturada: formato de dados organizado para fácil integração.
• Múltiplas linguagens de programação: suporte para JavaScript, Python, PHP e Swift.
• Tratamento de erros: respostas de erro abrangentes para diversos cenários.