Sign in

v1

latestOpenAPI 3.0.32026-07-2141248520.9 KB
HostedURL

Provide hosted url for a hosted version of onesdk.

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.

post/v2/individuals/hostedurl

Headers

api_keystring required
Example:245c765b124a098d09ef8765....

Your API key provided by FrankieOne

X-Frankie-CustomerIDstring required
Example:12345678-1234-1234-1234-123456789012

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstring
Example:87654321-4321-4321-4321-210987654321

Your Customer Child ID provided by FrankieOne

X-Frankie-Channelstring

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.

Request body

applicationRefstring

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.

channelRefstring

channel this application is being submitted through, eg WEB, MOBILE

consentboolean

Has user consented for IDV check. If not supplied or is false, consent will need to be submitted via provider SDK.

customerRefstring

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.

entityIdstring

Unique FrankieOne identifier for an entity if already created

errorRedirectURLstring

if provider sdk fails, redirect to this url

oneSDKFlowIdstring

Flow id to use for OneSDK, to determine what data needs to be captured from the user, for example :"idv" or "ocr_only"

phoneCodestring

country phone code

phoneNumberstring

phone code can be included with phone number or split out

recipientNamestring

if supplied will be used as the recipient name for the SMS

sendSMSboolean

if true, will send an SMS to the phone number supplied

successRedirectURLstring

url to redirect to on success

Example request

{
  "phoneNumber": "+6140000000",
  "comment": {
    "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7",
    "text": "Update after speaking to customer over the phone directly."
  }
}

Response

OK

statusstring

Status of the response for generating the onboarding URL and optionally sending via SMS.

urlstring

URL to redirect the user to for onboarding, will point to a page where the user can complete their onboarding or IDV check.

urlExpirystring date-time

The time at which the provided URL will expire according to configuration. Can not be set longer than 7 days

requestIdstring

The unique request identifier for the API call made.

entityIdstring

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.

Example response

{
  "urlExpiry": "2020-01-01T00:00:00.000Z",
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
  "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}