Skip to main content
POST
/
api
/
v1
/
verify
/
run_user_verification
cURL
curl --request POST \
  --url https://api.pearcheck.com/api/v1/verify/run_user_verification/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "verification_type": "ID",
  "first_name": "John",
  "last_name": "Doe",
  "date_of_birth": "2023-12-25",
  "phone_number": "+256000000000",
  "country_code": "UG",
  "id_type": "NATIONAL_ID",
  "middle_name": "Loe",
  "email_address": "jsmith@example.com",
  "id_number": "<string>",
  "id_document_front": "aSDinaTvuI8gbWludGxpZnk=",
  "id_document_back": "aSDinaTvuI8gbWludGxpZnk=",
  "selfie": "aSDinaTvuI8gbWludGxpZnk="
}
'
{
  "provider": "<string>",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "type": "<string>",
  "used_url": true,
  "verification_type": "<string>",
  "verification_result": "<string>",
  "id_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "user_input": {},
  "id_info": {},
  "phone_info": {},
  "aml_info": {},
  "risk_info": {},
  "fraud_insights": {},
  "face_match_info": {},
  "face_liveness_info": {},
  "verification_url": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

​
verification_type
enum<string>
required
  • ID - ID Verification
  • DOC - Document Verification
  • BIOMETRIC - Biometrics Verification
Available options:
ID,
DOC,
BIOMETRIC
​
first_name
string
required
Required string length: 2 - 50
Example:

"John"

​
last_name
string
required
Required string length: 2 - 50
Example:

"Doe"

​
date_of_birth
string<date>
required
​
phone_number
string
required
Example:

"+256000000000"

​
country_code
string
required
Required string length: 2
Example:

"UG"

​
id_type
enum<string>
required

*NATIONAL_ID - National ID

Available options:
NATIONAL_ID
​
middle_name
string
Maximum string length: 50
Example:

"Loe"

​
email_address
string<email> | null
​
id_number
string
​
id_document_front
string<byte>

Base64-encoded front of ID document (Required for Document & Biometrics Verification)

​
id_document_back
string<byte>

Base64-encoded back of ID document (Required for Document & Biometrics Verification)

​
selfie
string<byte>

Base64-encoded selfie image (Required for Biometrics Verification)

Response

Successful Operation

​
provider
string
required
​
batch_id
string<uuid>
required
​
status
string
required
​
type
string
required
​
used_url
boolean
required
​
verification_type
string
required
​
verification_result
string
required
​
id_type
string
required
​
created_at
string<date-time>
required
​
user_input
object
required
​
id_info
object
required
​
phone_info
object
required
​
aml_info
object
required
​
risk_info
object
required
​
fraud_insights
object
required
​
face_match_info
object
required
​
face_liveness_info
object
required
​
verification_url
string | null