KYC V2 APIHostedURL

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.

Headers

api_keystringRequired
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional

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

This endpoint expects an object.
applicationRefstringOptional
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.
channelRefstringOptional
channel this application is being submitted through, eg WEB, MOBILE
consentbooleanOptional
Has user consented for IDV check. If not supplied or is false, consent will need to be submitted via provider SDK.
customerRefstringOptional
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.
entityIdstringOptional
Unique FrankieOne identifier for an entity if already created
errorRedirectURLstringOptional
if provider sdk fails, redirect to this url
oneSDKFlowIdstringOptional

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

phoneCodestringOptional
country phone code
phoneNumberstringOptional
phone code can be included with phone number or split out
recipientNamestringOptional
if supplied will be used as the recipient name for the SMS
sendSMSbooleanOptional
if true, will send an SMS to the phone number supplied
successRedirectURLstringOptional
url to redirect to on success
commentobjectOptional

Response

OK
statusstring or null
Status of the response for generating the onboarding URL and optionally sending via SMS.
urlstring or null
URL to redirect the user to for onboarding, will point to a page where the user can complete their onboarding or IDV check.
urlExpirydatetime or null
The time at which the provided URL will expire according to configuration. Can not be set longer than 7 days
requestIdstring or null
The unique request ID for the API call made.
entityIdstring or null

Entity’s are assigned an auto-generated UUID to ensure global uniqueness, represented as an 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 call.

Errors