Skip to main content
POST
/
api
/
v1
/
verify
/
run_business_verification
/
cURL
curl --request POST \
  --url https://api.pearcheck.com/api/v1/verify/run_business_verification/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "business_entity_id": "<string>",
  "formation_date": "<string>",
  "alternate_name": "<string>",
  "tax_identification_number": "<string>",
  "website": "<string>",
  "country_code": "UG",
  "state_code": "<string>",
  "file_name": "<string>",
  "file_type": "<string>",
  "file_blob": "<string>"
}
'
import requests

url = "https://api.pearcheck.com/api/v1/verify/run_business_verification/"

payload = {
"name": "<string>",
"business_entity_id": "<string>",
"formation_date": "<string>",
"alternate_name": "<string>",
"tax_identification_number": "<string>",
"website": "<string>",
"country_code": "UG",
"state_code": "<string>",
"file_name": "<string>",
"file_type": "<string>",
"file_blob": "<string>"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
business_entity_id: '<string>',
formation_date: '<string>',
alternate_name: '<string>',
tax_identification_number: '<string>',
website: '<string>',
country_code: 'UG',
state_code: '<string>',
file_name: '<string>',
file_type: '<string>',
file_blob: '<string>'
})
};

fetch('https://api.pearcheck.com/api/v1/verify/run_business_verification/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pearcheck.com/api/v1/verify/run_business_verification/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'business_entity_id' => '<string>',
'formation_date' => '<string>',
'alternate_name' => '<string>',
'tax_identification_number' => '<string>',
'website' => '<string>',
'country_code' => 'UG',
'state_code' => '<string>',
'file_name' => '<string>',
'file_type' => '<string>',
'file_blob' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.pearcheck.com/api/v1/verify/run_business_verification/"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"business_entity_id\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"alternate_name\": \"<string>\",\n \"tax_identification_number\": \"<string>\",\n \"website\": \"<string>\",\n \"country_code\": \"UG\",\n \"state_code\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_blob\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.pearcheck.com/api/v1/verify/run_business_verification/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"business_entity_id\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"alternate_name\": \"<string>\",\n \"tax_identification_number\": \"<string>\",\n \"website\": \"<string>\",\n \"country_code\": \"UG\",\n \"state_code\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_blob\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.pearcheck.com/api/v1/verify/run_business_verification/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"business_entity_id\": \"<string>\",\n \"formation_date\": \"<string>\",\n \"alternate_name\": \"<string>\",\n \"tax_identification_number\": \"<string>\",\n \"website\": \"<string>\",\n \"country_code\": \"UG\",\n \"state_code\": \"<string>\",\n \"file_name\": \"<string>\",\n \"file_type\": \"<string>\",\n \"file_blob\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "provider": "<string>",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "In-progress",
  "type": "Single",
  "verification_type": "Business Verification",
  "verification_result": "UNKNOWN",
  "id_type": null,
  "created_at": "2023-11-07T05:31:56Z",
  "business_info": {},
  "aml_info": {},
  "lookup_info": {},
  "registration_info": {},
  "related_persons": {},
  "additional_info": {}
}
{
"error": {
"summary": "<string>",
"fields": {}
}
}

Authorizations

X-API-KEY
string
header
required

Body

verification_type
enum<string>
required
  • BUSINESS - Business Verification
  • DOC - Document Verification
Available options:
BUSINESS,
DOC
name
string
required
business_entity_id
string
required
formation_date
string
required
alternate_name
string
tax_identification_number
string
website
string
country_code
string
Required string length: 2
Example:

"UG"

state_code
string
file_name
string
file_type
string
file_blob
string

Response

Successful Operation

provider
string
batch_id
string<uuid>
status
string
Example:

"In-progress"

type
string
Example:

"Single"

verification_type
string
Example:

"Business Verification"

verification_result
string
Example:

"UNKNOWN"

id_type
string | null
Example:

null

created_at
string<date-time>
business_info
object
aml_info
object
lookup_info
object
registration_info
object
additional_info
object