Sign in

f1e9dc8f2dd5

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYB > Verification (Profile-Based)

Run Business Verification

Run verification against a previously created business profile.

post/verify/run_verification_for_business_profile_id

Request body

business_profile_idstring required
template_idstring required

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

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",
  "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810"
}

Response

Successful operation

verification_session_idstring
template_idstring
client_reference_idstring nullable
client_reference_dataobject nullable
created_atinteger
status'NOT_STARTED' | 'RUNNING' | 'PENDING' | 'FAILED' | 'COMPLETED' | 'SUBMITTED' nullable

The overall workflow result status.

time_elapsed_to_processstring
time_elapsed_to_complete_sessionstring
field_infoobject
sourcesstring[]