---
title: "Provide hosted url for a hosted version of onesdk."
method: POST
path: "/v2/individuals/hostedurl"
tags: ["HostedURL"]
---

# Provide hosted url for a hosted version of onesdk.

`POST /v2/individuals/hostedurl`

Hosted OneSDK URL Generation, used to request a hosted OneSDK URL with entity specific token for a customer to use a hosted OneSDK session to do an action. Examples of actions that may be done is to complete their onboarding process or to re-attempt IDV checks.  If sendSMS is true and a phone number is supplied, an SMS will be sent to the phone number with the generated URL.

## Headers

- `api_key` string, required
- `X-Frankie-CustomerID` string, required
- `X-Frankie-CustomerChildID` string
- `X-Frankie-Channel` string

## Request body

- IDVHostedUrlRequest — Hosted OneSDK URL Request, used to request a hosted OneSDK URL with entity specific token for a customer to use a hosted OneSDK session to do an action. Examples of actions that may be done is to complete their onboarding process or to re-attempt IDV checks. If sendSMS is true and a phone number is supplied, an SMS will be sent to the phone number with the generated URL.
  - `applicationRef` string — Reference or name of the application running this IDV check. Specify this if running this check embedded in a application rather than a web page.
  - `channelRef` string — channel this application is being submitted through, eg WEB, MOBILE
  - `consent` boolean — Has user consented for IDV check. If not supplied or is false, consent will need to be submitted via provider SDK.
  - `customerRef` string — external customer reference for this entity. If supplied and an entity id not, we will search for an entity with this customer ref. If not found, a new entity will be created with this customer ref.
  - `entityId` string — Unique FrankieOne identifier for an entity if already created
  - `errorRedirectURL` string — if provider sdk fails, redirect to this url
  - `oneSDKFlowId` string — Flow id to use for OneSDK, to determine what data needs to be captured from the user, for example :"idv" or "ocr_only"
  - `phoneCode` string — country phone code
  - `phoneNumber` string — phone code can be included with phone number or split out
  - `recipientName` string — if supplied will be used as the recipient name for the SMS
  - `sendSMS` boolean — if true, will send an SMS to the phone number supplied
  - `successRedirectURL` string — url to redirect to on success
  - `comment` Comment
    - `commentId` string — Unique identifier for the comment.
    - `text` string — The text content of the comment.

## Response `200`

OK

- IDVHostedUrlResponse — Onboarding URL Response, contains the url for onboarding as well as the expiry. Each call to this endpoint will generate a new URL with a new expiry.
  - `status` string — Status of the response for generating the onboarding URL and optionally sending via SMS.
  - `url` string — URL to redirect the user to for onboarding, will point to a page where the user can complete their onboarding or IDV check.
  - `urlExpiry` string, date-time — The time at which the provided URL will expire according to configuration. Can not be set longer than 7 days
  - `requestId` string — The unique request identifier for the API call made.
  - `entityId` string — Entities are assigned an auto-generated UUID to ensure global uniqueness, represented as entityId. The entityId allows for precise modification when required. To modify an entity, set the entityId of the entity you wish to update in an update request.

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable

---

[API](https://skmtc.net/frankieone/apis/kyc-v2-api.md) · [All operations](https://skmtc.net/frankieone/apis/kyc-v2-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/frankieone/kyc-v2-api/revisions/880b27506cbb/schema)