ブラジル

API リファレンス

エンドポイント

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

CPF と 生年月日 を用いた ブラジルの個人バックグラウンド調査 を実行します。レスポンスには本人確認関連のフィールドが含まれ、データプロバイダーから提供される場合は base64 エンコードされた PDF レポートも返されます。採用スクリーニング、デューデリジェンス、コンプライアンス などの用途を想定しています。PDF やメタデータの取り扱いは、お客様自身の法令および保管ルールに従ってください。

ヘッダー

名前	値
Accept	application/json
Authorization	Bearer <token>

パラメーター

info

対応する 文書タイプ とそれぞれの必須パラメーターの一覧については、文書タイプ ガイドをご参照ください。

名前	型	必須	説明
documentType	string	はい	文書タイプ。許可される値: CPF。
documentNumber	string	はい	照会対象者の文書番号。
dateOfBirth	string	はい	照会対象者の生年月日。形式: dd/mm/yyyy。

リクエスト

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 <your_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 <your_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 <your_token>',
  ],
]);

echo $response->getBody();

Swift

import Foundation

let headers = [
  "Accept": "application/json",
  "Authorization": "Bearer <your_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()

レスポンス

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 (不正な文書タイプ)

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

機能

• CPF 検証: ブラジルの CPF 文書の真正性を検証します。
• 完全なバックグラウンドデータ: 氏名、文書詳細、認証番号、PDF レポートを返します。
• 構造化されたレスポンス: 統合しやすい整理されたデータ形式で返却されます。
• 複数のプログラミング言語に対応: JavaScript、Python、PHP、Swift をサポートします。
• エラーハンドリング: 各種シナリオに対応した包括的なエラーレスポンスを提供します。