Create verification session URL

post

https://api-sandbox.aiprise.com/api/v1/verify/create_verification_session_url_for_user_profile

Create a URL for user verification session

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Create verification URL request

user_profile_id

string

required

redirect_uri

string

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_id

string

required

client_reference_id

string

An id you want to associate with your request.

client_reference_data

object

A JSON you want to associate with your request.

theme_options

object

ui_options

object

verification_options

object

Responses

400

Bad Request

Language

Credentials

Header

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful operation