🇧🇷 브라질

API 레퍼런스

엔드포인트

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

브라질 개인 배경 조회를 CPF와 출생일로 수행합니다. 정상 응답에는 신원 관련 필드가 포함되며, 데이터 제공자가 제공할 경우 base64로 인코딩된 PDF 보고서가 함께 반환됩니다. 채용 검증, 실사, 컴플라이언스 목적에 적합합니다. PDF와 메타데이터의 처리 및 보존 정책은 자체 법적 기준에 따라 관리하시기 바랍니다.

헤더(Headers)

이름	값
Accept	application/json
Authorization	Bearer <token>

매개변수(Parameters)

info

지원되는 문서 종류의 전체 목록과 각 종류별 필수 매개변수는 Document Types 가이드를 참고해 주세요.

이름	형식	필수	설명
documentType	string	예	문서 종류. 허용 값: CPF.
documentNumber	string	예	조회 대상자의 문서 번호.
dateOfBirth	string	예	조회 대상자의 출생일. 형식: dd/mm/yyyy.

요청(Request)

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()

응답(Response)

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 예제를 제공합니다.
• 오류 처리: 다양한 시나리오에 대한 상세한 오류 응답을 제공합니다.