---
title: "Get user verification url"
method: POST
path: "/verify/get_user_verification_url"
tags: ["KYC > Quick Start"]
---

# Get user verification url

`POST /verify/get_user_verification_url`

Endpoint used to get user verification url

## Request body

- UserVerificationUrlRequest
  - `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 — Every verification must have a template id associated with it. This is Provided to you by AiPrise.
  - `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.
  - `callback_url` string
  - `events_callback_url` string
  - `user_data` PartialUserData
    - `first_name` string — The person's first name
    - `middle_name` string — The person's middle name
    - `last_name` string — The person's last name
    - `date_of_birth` string — The person's date of birth in YYYY-MM-DD format
    - `phone_number` string — The person's phone number. Prefer phone number in E.164 format
    - `email_address` string — The person's email address
    - `ip_address` string — The person's ip address
    - `address` Address
      - `address_street_1` string — Address street 1
      - `address_street_2` string — Address street 2
      - `address_city` string — Address city
      - `address_state` string — Address state or region
      - `address_zip_code` string — Address zip code
      - `address_country` string — 2-letter address country code
  - `additional_info` IndividualAdditionalInfo[] — A list of additional information.
    - `additional_info_type` 'KENYA_KRA_PIN' | 'BANK_STATEMENT_DOCUMENT' | 'OPERATING_LICENSE_DOCUMENT' | 'SOURCE_OF_FUNDS_DOCUMENT' | 'BUSINESS_REGISTRATION_DOCUMENT' | 'VISA_DOCUMENT' | 'USER_SELFIE' | 'GENDER' | 'ADDRESS_PROOF_DOCUMENT' | 'NIGERIA_BVN_NUMBER' | 'TAX_IDENTIFICATION_NUMBER' | 'PREVIOUS_VERIFICATION_SESSION_ID' | 'FRAUD_CHECK_DOCUMENT' | 'BANK_ACCOUNT_DETAILS' | 'TAX_CERTIFICATE' | 'OTHER' — The type of additional data.
    - `additional_info_data` union
      - string — The additional data as a string.
      - object — The additional data as an object. For file-based types, may include file_data, file_uuid, and document_input_title.
        - `file_data` string — The file content as base64 or S3 URL.
        - `file_uuid` string — The unique identifier of the file.
        - `document_input_title` string, nullable — An optional unique identifier for the document input, if provided during document check.
  - `theme_options` ThemeOptions
    - `background` 'light' | 'dark', nullable
    - `color_page` string, nullable
    - `color_brand` string, nullable
    - `color_brand_overlay` string, nullable
    - `font_name` string, nullable
    - `font_weights` string, nullable
    - `button_border_radius` string, nullable
    - `button_padding` string, nullable
    - `button_font_size` string, nullable
    - `button_font_weight` string, nullable
    - `input_border_radius` string, nullable
    - `input_padding` string, nullable
    - `input_font_size` string, nullable
    - `input_font_weight` string, nullable
    - `input_label_font_size` string, nullable
    - `input_label_font_weight` string, nullable
    - `layout_border_radius` string, nullable
    - `modal_border_radius` string, nullable
    - `image_border_radius` string, nullable
  - `ui_options` UIOptions
    - `common` object
      - `default_language` string
    - `id_verification_module` object
      - `allowed_country_code` string — A 2-letter ISO country code that will be pre-selected in the onboarding UI.
      - `allowed_document_type` union — A list of document types that will be pre-selected in the onboarding UI. Type string is deprecated, please use array of string(s). Check the country-wise supported documents list here: https://docs.aiprise.com/docs/supported-documents
        - string[]
        - string
  - `verification_options` VerificationOptions
    - `aml_config` object
      - `exact_match` number
      - `fuzziness_score` number
      - `monitoring` boolean
      - `categories_filter` string[]
      - `search_profile` string, nullable

## Response `200`

Successful operation

- UserVerificationUrlResponse
  - `message` string
  - `verification_url` string
  - `verification_session_id` string — The unique identifier for the verification session
  - `session_expiry_time` string — The expiration time for the verification session

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/aiprise/apis/aiprise-apis.md) · [All operations](https://skmtc.net/aiprise/apis/aiprise-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aiprise/aiprise-apis/revisions/f1e9dc8f2dd5/schema)