API Endpoints

API Endpoints for User Verification

AiPrise uses one core endpoint to run all types of user verification workflows. This includes:

Document KYC (passport, ID card, driver’s license, etc.)
One-Click KYC (registry lookups / government checks)
Biometric checks (face match, liveness)
AML screening
Fraud checks (email, phone, device)
Address verification
Custom workflows (risk scoring, questionnaires, advanced flows)

📘
All verification behavior is controlled by the template you pass in the request. Each template_id maps to a workflow that defines:

Which checks run

In what order

With what risk and decision logic

To learn more about templates, see Template Configuration

Core Endpoints

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