Documentation Index
Fetch the complete documentation index at: https://docs.pearcheck.com/llms.txt
Use this file to discover all available pages before exploring further.
For all user verifications:
- KYC
- Govt Check
- AML Check
- Fraud Check
- Biometric Check
- Additional Info
PearCheck returns a streamlined response.
This document shows the structure of that response:
{
"data": {
"provider": "Pearcheck",
"batch_id": "826c3b12-c321-4a25-8691-c2ee4bad6baf",
"status": "In-progress",
"type": "Single",
"used_url": false,
"verification_type": "ID Verification",
"verification_result": "UNKNOWN",
"verification_url": null,
"id_type": "National ID",
"created_at": "2025-06-11T06:46:00.639929+01:00",
"user_input": {
"name": {
"first": "Martin",
"middle": null,
"last": "Smith"
},
"dob": "2025-01-03",
"email": null,
"phone": "+256000000000",
"address": {
"street_1": null,
"street_2": null,
"city": null,
"state": null,
"country": null,
"zip_code": null
},
"identity": {
"type": "NATIONAL_ID",
"number": "B69631112",
"country_code": "UG",
"document_front": "",
"document_back": "",
"document_type": null
},
"biometrics": {
"selfie": "",
"selfie_video": "",
"selfie_record": "",
"smile_selfie": ""
}
},
"id_info": {},
"phone_info": {},
"aml_info": {},
"risk_info": {},
"fraud_insights": {
"email_insights": null,
"phone_insights": null
},
"face_match_info": {},
"face_liveness_info": {}
},
"status": 200
}
| Key | Value |
|---|
| batch_id | Batch ID (unique to every verification session). |
| environment | In the sandbox, returns SANDBOX, in production, returns null |
| user_input | Input details used for the verification |
| id_info | Contains all the information extracted from the identity document. |
| phone_info | Contains Phone number checks of the user if phone number was provided. |
| aml_info | Contains AML checks of the user. |
| fraud_insights | Contains fraud insights of the user. |
| face_match_info | Contains information about the face match between selfie and the identity document. |
| face_liveness_info | Contains information about user liveness. |
