Skip to main content
POST
/
v2
/
individuals
/
hostedurl
Provide hosted url for a hosted version of onesdk.
curl --request POST \
  --url https://api.uat.frankie.one/v2/individuals/hostedurl \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "applicationRef": "<string>",
  "channelRef": "<string>",
  "consent": true,
  "customerRef": "<string>",
  "entityId": "<string>",
  "errorRedirectURL": "<string>",
  "oneSDKFlowId": "<string>",
  "phoneCode": "<string>",
  "phoneNumber": "+6140000000",
  "recipientName": "<string>",
  "sendSMS": true,
  "successRedirectURL": "<string>",
  "comment": {
    "text": "Update after speaking to customer over the phone directly.",
    "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "entityType": "INDIVIDUAL"
  },
  "requestedDocuments": [
    {
      "documentType": "<string>",
      "subType": "<string>"
    }
  ],
  "optionalDocuments": [
    {
      "documentType": "<string>",
      "subType": "<string>"
    }
  ],
  "partialDocuments": [
    {
      "title": "<string>",
      "minimumRequirement": 123,
      "documents": [
        {
          "documentType": "<string>",
          "subType": "<string>"
        }
      ]
    }
  ]
}
'
{
  "status": "<string>",
  "url": "<string>",
  "urlExpiry": "2020-01-01T00:00:00.000Z",
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Authorizations

​
api_key
string
header
required

Headers

​
api_key
string
required

Your API key provided by FrankieOne

Example:

"245c765b124a098d09ef8765...."

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

​
X-Frankie-Channel
string

Open string that can be used to define the "channel" the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

Body

application/json

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

Example:

"+6140000000"

​
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
object
​
requestedDocuments
object[]

List of documents that are requested from customer for onesdk session

​
optionalDocuments
object[]

List of documents that are optional from customer for onesdk session

​
partialDocuments
object[]

List of documents that are partial from customer for onesdk session

Response

OK

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

Example:

"2020-01-01T00:00:00.000Z"

​
requestId
string

The unique request identifier for the API call made.

Example:

"01HN9XHZN6MGXM9JXG50K59Q85"

​
entityId
string

Entities are assigned a FrankieOne 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.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"