cURL
curl --request POST \
--url https://api.pearcheck.com/api/v1/verify/get_user_verification_url/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"send_to_email": false,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"phone_number": "<string>"
}
'import requests
url = "https://api.pearcheck.com/api/v1/verify/get_user_verification_url/"
payload = {
"send_to_email": False,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"phone_number": "<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({
send_to_email: false,
email_address: 'jsmith@example.com',
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
date_of_birth: '<string>',
phone_number: '<string>'
})
};
fetch('https://api.pearcheck.com/api/v1/verify/get_user_verification_url/', 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/get_user_verification_url/",
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([
'send_to_email' => false,
'email_address' => 'jsmith@example.com',
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '<string>',
'phone_number' => '<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/get_user_verification_url/"
payload := strings.NewReader("{\n \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<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/get_user_verification_url/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pearcheck.com/api/v1/verify/get_user_verification_url/")
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 \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verification_url": "<string>"
},
"status": 123
}{
"error": {
"summary": "<string>",
"fields": {}
}
}User Verification (KYC) APIs
Get user verification url
Endpoint used to get user verification url
POST
/
api
/
v1
/
verify
/
get_user_verification_url
/
cURL
curl --request POST \
--url https://api.pearcheck.com/api/v1/verify/get_user_verification_url/ \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"send_to_email": false,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"phone_number": "<string>"
}
'import requests
url = "https://api.pearcheck.com/api/v1/verify/get_user_verification_url/"
payload = {
"send_to_email": False,
"email_address": "jsmith@example.com",
"first_name": "<string>",
"middle_name": "<string>",
"last_name": "<string>",
"date_of_birth": "<string>",
"phone_number": "<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({
send_to_email: false,
email_address: 'jsmith@example.com',
first_name: '<string>',
middle_name: '<string>',
last_name: '<string>',
date_of_birth: '<string>',
phone_number: '<string>'
})
};
fetch('https://api.pearcheck.com/api/v1/verify/get_user_verification_url/', 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/get_user_verification_url/",
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([
'send_to_email' => false,
'email_address' => 'jsmith@example.com',
'first_name' => '<string>',
'middle_name' => '<string>',
'last_name' => '<string>',
'date_of_birth' => '<string>',
'phone_number' => '<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/get_user_verification_url/"
payload := strings.NewReader("{\n \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<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/get_user_verification_url/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pearcheck.com/api/v1/verify/get_user_verification_url/")
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 \"send_to_email\": false,\n \"email_address\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"middle_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"date_of_birth\": \"<string>\",\n \"phone_number\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verification_url": "<string>"
},
"status": 123
}{
"error": {
"summary": "<string>",
"fields": {}
}
}Authorizations
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
ID- ID VerificationDOC- Document VerificationBIOMETRIC- Biometrics Verification
Available options:
ID, DOC, BIOMETRIC Maximum string length:
50Maximum string length:
50Maximum string length:
50⌘I