Sign in

v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB
KYC > Quick Start

Get user verification url

Endpoint used to get user verification url

post/verify/get_user_verification_url

Request body

redirect_uristring required

Controls how the onboarding widget signals completion. Pass a reserved keyword — iframe, popup, popup_close, manual_close, react_native, flutter, ios, or android — to have the widget post the AiPriseVerification:Complete message to your host app, or pass a URL to redirect the browser on completion (the session id is appended as verification_session_id for KYC or business_onboarding_session_id for KYB). See the Redirect modes guide for the full list of behaviors.

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",
  "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"
    }
  },
  "theme_options": {
    "color_page": "#5251FD",
    "color_brand": "#5251FD",
    "color_brand_overlay": "#5251FD",
    "font_name": "Plus Jakarta Sans",
    "font_weights": "300,400,500,600,700",
    "button_border_radius": "8px",
    "button_padding": "18px",
    "button_font_size": "16px",
    "button_font_weight": "400",
    "input_border_radius": "8px",
    "input_padding": "14px 18px",
    "input_font_size": "16px",
    "input_font_weight": "500",
    "input_label_font_size": "16px",
    "input_label_font_weight": "500",
    "layout_border_radius": "18px",
    "modal_border_radius": "12px",
    "image_border_radius": "12px"
  },
  "ui_options": {
    "common": {
      "default_language": "en"
    },
    "id_verification_module": {
      "allowed_country_code": "US",
      "allowed_document_type": [
        "ID_CARD",
        "PASSPORT"
      ]
    }
  }
}

Response

Successful operation

messagestring
verification_urlstring
verification_session_idstring

The unique identifier for the verification session

session_expiry_timestring

The expiration time for the verification session

Example response

{
  "message": "Success",
  "verification_url": "https://verify-sandbox.aiprise.com/?verification_session_id=123",
  "verification_session_id": "abc123-def456-ghi789",
  "session_expiry_time": "2024-12-31T23:59:59Z"
}