Skip to main content
POST
/
v2.1
/
organizations
/
hostedUrl
Generate Hosted URL
curl --request POST \
  --url https://api.uat.frankie.one/v2.1/organizations/hostedUrl \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'api_key: <api-key>' \
  --data '
{
  "flowId": "example-flow-id"
}
'
{
  "url": "https://verify.uat.frankie.one/v2/?t=shortToken",
  "urlExpiry": "2020-01-01T00:00:00.000Z",
  "requestId": "01HN9XHZN6MGXM9JXG50K59Q85"
}

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
​
flowId
string
required
Example:

"example-flow-id"

Response

OK

​
url
string

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

Example:

"https://verify.uat.frankie.one/v2/?t=shortToken"

​
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"