---
updatedAt: 2026-08-04T02:54:38.000Z
agentTools:
  projectIndex: https://docs.aiprise.com/llms.txt
---

# Create verification session URL

Create a URL for user verification session

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "AiPrise APIs",
    "description": "AiPrise API documentation",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api-sandbox.aiprise.com/api/v1/",
      "description": "Sandbox server"
    },
    {
      "url": "https://api.aiprise.com/api/v1/",
      "description": "Production server"
    }
  ],
  "tags": [
    {
      "name": "KYC > Verification (Profile-Based)",
      "description": "Run verification against a user profile."
    }
  ],
  "paths": {
    "/verify/create_verification_session_url_for_user_profile": {
      "post": {
        "tags": [
          "KYC > Verification (Profile-Based)"
        ],
        "summary": "Create verification session URL",
        "description": "Create a URL for user verification session",
        "requestBody": {
          "description": "Create verification URL request",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CreateVerificationURLForUserProfileRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful operation",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "verification_url": {
                      "type": "string"
                    },
                    "verification_session_id": {
                      "type": "string"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CreateVerificationURLForUserProfileRequest": {
        "type": "object",
        "required": [
          "user_profile_id",
          "template_id",
          "redirect_uri"
        ],
        "properties": {
          "user_profile_id": {
            "type": "string"
          },
          "redirect_uri": {
            "type": "string",
            "description": "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 [Redirect modes](https://docs.aiprise.com/docs/template-configuration) for the full list of behaviors."
          },
          "template_id": {
            "type": "string"
          },
          "client_reference_id": {
            "type": "string",
            "example": "b79160f1-3ea5-4bf0-be43-43c4a2cf8810",
            "description": "An id you want to associate with your request."
          },
          "client_reference_data": {
            "type": "object",
            "description": "A JSON you want to associate with your request."
          },
          "theme_options": {
            "$ref": "#/components/schemas/ThemeOptions"
          },
          "ui_options": {
            "$ref": "#/components/schemas/UIOptions"
          },
          "verification_options": {
            "$ref": "#/components/schemas/VerificationOptions"
          }
        }
      },
      "ThemeOptions": {
        "type": "object",
        "properties": {
          "background": {
            "type": "string",
            "nullable": true,
            "enum": [
              "light",
              "dark"
            ]
          },
          "color_page": {
            "type": "string",
            "nullable": true,
            "example": "#5251FD"
          },
          "color_brand": {
            "type": "string",
            "nullable": true,
            "example": "#5251FD"
          },
          "color_brand_overlay": {
            "type": "string",
            "nullable": true,
            "example": "#5251FD"
          },
          "font_name": {
            "type": "string",
            "nullable": true,
            "example": "Plus Jakarta Sans"
          },
          "font_weights": {
            "type": "string",
            "nullable": true,
            "example": "300,400,500,600,700"
          },
          "button_border_radius": {
            "type": "string",
            "nullable": true,
            "example": "8px"
          },
          "button_padding": {
            "type": "string",
            "nullable": true,
            "example": "18px"
          },
          "button_font_size": {
            "type": "string",
            "nullable": true,
            "example": "16px"
          },
          "button_font_weight": {
            "type": "string",
            "nullable": true,
            "example": "400"
          },
          "input_border_radius": {
            "type": "string",
            "nullable": true,
            "example": "8px"
          },
          "input_padding": {
            "type": "string",
            "nullable": true,
            "example": "14px 18px"
          },
          "input_font_size": {
            "type": "string",
            "nullable": true,
            "example": "16px"
          },
          "input_font_weight": {
            "type": "string",
            "nullable": true,
            "example": "500"
          },
          "input_label_font_size": {
            "type": "string",
            "nullable": true,
            "example": "16px"
          },
          "input_label_font_weight": {
            "type": "string",
            "nullable": true,
            "example": "500"
          },
          "layout_border_radius": {
            "type": "string",
            "nullable": true,
            "example": "18px"
          },
          "modal_border_radius": {
            "type": "string",
            "nullable": true,
            "example": "12px"
          },
          "image_border_radius": {
            "type": "string",
            "nullable": true,
            "example": "12px"
          }
        }
      },
      "UIOptions": {
        "type": "object",
        "properties": {
          "common": {
            "type": "object",
            "properties": {
              "default_language": {
                "type": "string",
                "example": "en"
              }
            }
          },
          "id_verification_module": {
            "type": "object",
            "properties": {
              "allowed_country_code": {
                "type": "string",
                "example": "US",
                "description": "A 2-letter ISO country code that will be pre-selected in the onboarding UI."
              },
              "allowed_document_type": {
                "oneOf": [
                  {
                    "type": "array",
                    "items": {
                      "type": "string"
                    },
                    "example": [
                      "ID_CARD",
                      "PASSPORT"
                    ]
                  },
                  {
                    "type": "string",
                    "example": "ID_CARD"
                  }
                ],
                "description": "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"
              }
            }
          }
        }
      },
      "VerificationOptions": {
        "type": "object",
        "properties": {
          "aml_config": {
            "type": "object",
            "properties": {
              "exact_match": {
                "type": "number"
              },
              "fuzziness_score": {
                "type": "number"
              },
              "monitoring": {
                "type": "boolean"
              },
              "categories_filter": {
                "type": "array",
                "items": {
                  "type": "string"
                }
              },
              "search_profile": {
                "type": "string",
                "nullable": true
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY",
        "description": "All requests must include the `X-API-KEY` header containing your API Key."
      }
    }
  },
  "security": [
    {
      "apiKey": []
    }
  ]
}
```