v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB

KYC > Verification (Profile-Based)

Create verification session URL

Create a URL for user verification session

post/verify/create_verification_session_url_for_user_profile

Request body

user_profile_idstring required

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

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

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

verification_urlstring

verification_session_idstring