KYB V2.1 API - PreviewHosted URL

Generate Hosted URL

Generate a hosted URL for onboarding new organization.

Authentication

api_keystring
API Key authentication via header

Headers

api_keystringRequired
Your API key provided by FrankieOne
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.
flowIdstringRequired

Response

OK
urlstring or null
URL to redirect the user to for onboarding, will point to a page where the user can complete their onboarding
urlExpirystring or nullformat: "date-time"
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 identifier for the API call made.

Errors