Get user verification url

Endpoint used to get user verification url

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

User verification request with redirect URL

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.

string
required

Every verification must have a template id associated with it. This is Provided to you by AiPrise.

string

An id you want to associate with your request.

client_reference_data
object

A JSON you want to associate with your request.

string
string
user_data
object
additional_info
array of objects

A list of additional information.

additional_info
theme_options
object
ui_options
object
verification_options
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

400

Bad Request

Callback
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json