v1

latestOpenAPI 3.0.02026-07-2468247202.3 KB

KYB > Verification (Profile-Based)

Get business verification url

Endpoint used to get business verification url. Initializes the onboarding SDK & creates a business profile internally.

post/verify/get_business_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.

business_profile_idstring

The business profile id to associate with the verification session.

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

associated_emailstring

Email address to associate with the session for later resumption.

Example request

{
  "template_id": "b7daff11-9d1c-4916-bf5a-96e3041a9625",
  "business_profile_id": "123e4567-e89b-12d3-a456-426614174000",
  "client_reference_id": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810",
  "callback_url": "https://yourwebsite.com/aiprise-callback",
  "events_callback_url": "https://yourwebsite.com/aiprise-callback",
  "associated_email": "user@example.com",
  "business_data": {
    "name": "AiPrise",
    "alternate_name": "AiPrise Inc",
    "website": "www.aiprise.com",
    "formation_date": "1999-03-21",
    "country_code": "US",
    "addresses": [
      {
        "address_street_1": "222 Palm Street",
        "address_city": "Santa Monica",
        "address_state": "CA",
        "address_zip_code": "93251",
        "address_country": "US"
      }
    ],
    "phone_numbers": [
      "+13334445555"
    ]
  },
  "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"
    },
    "dynamic_business_question_group_module": {
      "questions": {
        "Q01": {
          "type": "SINGLE_CHOICE",
          "title": {
            "en": "What is your business type?"
          },
          "subtitle": {
            "en": "Select one"
          },
          "required": true,
          "order": 0,
          "options": [
            {
              "en": "Retail",
              "fr": "Vente au détail"
            },
            {
              "en": "Wholesale",
              "fr": "Vente en gros"
            }
          ]
        },
        "Q02": {
          "type": "TEXT",
          "title": {
            "en": "Describe your services"
          },
          "subtitle": {
            "en": ""
          },
          "required": false,
          "order": 1
        }
      }
    }
  }
}

Response

Successful operation

messagestring

verification_urlstring

Example response

{
  "message": "Success",
  "verification_url": "https://verify-sandbox.aiprise.com/?business_onboarding_session_id=123"
}