v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB

KYB > Quick Start

Run business verification

Endpoint used to run business verification

post/verify/run_business_verification

Request body

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.

callback_urlstring

events_callback_urlstring

Example request

{
  "template_id": "b7daff11-9d1c-4916-bf5a-96e3041a9625",
  "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810",
  "callback_url": "https://yourwebsite.com/aiprise-callback",
  "events_callback_url": "https://yourwebsite.com/aiprise-callback",
  "business_data": {
    "name": "AiPrise",
    "alternate_name": "AiPrise Inc",
    "website": "www.aiprise.com",
    "formation_date": "1999-03-21",
    "country_code": "US",
    "addresses": [
      {
        "address_street_1": "222 Palm Street",
        "address_city": "Santa Monica",
        "address_state": "CA",
        "address_zip_code": "93251",
        "address_country": "US"
      }
    ],
    "phone_numbers": [
      "+13334445555"
    ]
  }
}

Response

Successful operation

verification_session_idstring

template_idstring

client_reference_idstring nullable

client_reference_dataobject nullable

created_atinteger

The overall workflow result status.

time_elapsed_to_processstring

time_elapsed_to_complete_sessionstring

field_infoobject

sourcesstring[]