v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYB > Verification of Related Entities (V1)

KYC Business Officer - Run Verification

KYC the business officer.

post/verify/run_verification_for_business_officer

Request body

business_profile_idstring required
person_reference_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",
  "user_data": {
    "first_name": "John",
    "last_name": "Smith",
    "date_of_birth": "1984-01-21",
    "phone_number": "+13334445555",
    "email_address": "johnsmith@aiprise.com",
    "address": {
      "address_street_1": "222 Palm Street",
      "address_city": "Santa Monica",
      "address_state": "CA",
      "address_zip_code": "93251",
      "address_country": "US"
    },
    "identity": {
      "identity_country_code": "US",
      "identity_document_front": "BASE64_ENCODED_IMAGE",
      "identity_document_back": "BASE64_ENCODED_IMAGE"
    },
    "selfie": "BASE64_ENCODED_IMAGE",
    "selfie_video": "BASE64_ENCODED_VIDEO"
  }
}

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