API Endpoints

AiPrise uses only ONE endpoint to run user verification of all kinds:

KYC - (Document KYC, One-Click KYC)
Govt Check
Biometric Check
AML Check
Fraud (phone & email) Check
Address Verification Check
Custom Check (custom workflows).

That endpoint is /run_user_verification. So to differentiate between 2 different checks, you pass in a template_id in the request. Each template is associated with a workflow which runs a series of checks. To read more about templates, please click here.

Endpoint	Description
POST /run_user_verification	This endpoint takes in all data required to run a user verification workflow and returns a verification result. You can run the API here.
POST /get_user_verification_url	Use this endpoint to get verification URL associated with a `template_id`. Note that not every template has AiPrise SDK associated with them. Contact AiPrise if you want to enable SDK for a particular template. You can run the API here.
POST /resume_user_verification	Some workflows can pause in the middle and requires more user input data. This endpoint takes in the additional user input data and resumes the verification workflow. Most verification workflows will never need to use this endpoint. You can run the API here.
GET /get_user_verification_result/ {session_id}	If you want to fetch a verification result in the future, you can use this endpoint. It only requires a`verification_session_id`. You can run the API here.
GET /get_user_data_from_request/ {session_id}	If you want to fetch user input data for a `verification_session_id`, you can use this endpoint. You can run the API here.
GET /get_additional_user_info_from_request/ {session_id}	Use this endpoint to get additional input data given by the user. You can run the API here.
POST /update_user_verification_result	Use this endpoint to update the result of a verification session. You can run the API here
GET /get_case_activity/{session_id}	Use this endpoint to get case activity of a verification session. You can run the API here