User Verification (KYC) APIs
User Verification (KYC) APIs
Run user verification
Endpoint used to run user verification
POST
/
api
/
v1
/
verify
/
run_user_verification
/
cURL
Copy
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",
"middle_name": "Loe",
"last_name": "Doe",
"date_of_birth": "2023-12-25",
"phone_number": "+256000000000",
"email_address": "jsmith@example.com",
"country_code": "UG",
"id_type": "NATIONAL_ID",
"id_number": "<string>",
"id_document_front": "aSDinaTvuI8gbWludGxpZnk=",
"id_document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk="
}'
Copy
{
"provider": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"type": "<string>",
"used_url": true,
"verification_type": "<string>",
"verification_result": "<string>",
"verification_url": "<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": {}
}
Authorizations
Body
Response
200
application/json
Successful Operation
The response is of type object
.
cURL
Copy
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",
"middle_name": "Loe",
"last_name": "Doe",
"date_of_birth": "2023-12-25",
"phone_number": "+256000000000",
"email_address": "jsmith@example.com",
"country_code": "UG",
"id_type": "NATIONAL_ID",
"id_number": "<string>",
"id_document_front": "aSDinaTvuI8gbWludGxpZnk=",
"id_document_back": "aSDinaTvuI8gbWludGxpZnk=",
"selfie": "aSDinaTvuI8gbWludGxpZnk="
}'
Copy
{
"provider": "<string>",
"batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"type": "<string>",
"used_url": true,
"verification_type": "<string>",
"verification_result": "<string>",
"verification_url": "<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": {}
}
Assistant
Responses are generated using AI and may contain mistakes.