Sign in

v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYC > Document Management

Run Document Check

Run check on a user document for a previously created user profile.

post/verify/run_check_on_user_document

Request body

user_profile_idstring required
template_idstring required

Every verification must have a template id associated with it. This is Provided to you by AiPrise.

file_uuidstring required
document_input_titlestring nullable

An optional unique identifier for the document input. This title is returned in webhook payloads and API responses to help map documents to your internal systems.

client_reference_idstring

An id you want to associate with your request.

client_reference_dataobject

A JSON you want to associate with your request.

Example request

{
  "template_id": "b7daff11-9d1c-4916-bf5a-96e3041a9625",
  "document_input_title": "Bank Statement Q4 2024",
  "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810"
}

Response

Successful operation

status'NOT_STARTED' | 'RUNNING' | 'PENDING' | 'FAILED' | 'COMPLETED' | 'SUBMITTED' nullable

The overall workflow result status.

client_reference_idstring
client_reference_dataobject
created_atinteger
template_idstring
verification_session_idstring
time_elapsed_to_processstring
time_elapsed_to_complete_sessionstring
environmentstring nullable