(AUS Only) Generate Onboarding URL | FrankieOne

Generate a hosted URL for onboarding new organization.

Authentication

api_keystring

API Key authentication via header

Headers

X-Frankie-CustomerChildIDstringOptionalformat: "uuid"

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID.

Note: If using a CustomerChildID, you will also need a separate api_key for each child.

Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer’s Children will not be able to see each other’s data.

A Customer can see the documents/entities and checks of all their Children.

If, as a Frankie Customer, you are acting on behalf of your own customers, then you can populate this field with a Frankie-assigned ID. Note: If using a CustomerChildID, you will also need a separate api_key for each child. Any documents, checks, entities that are created when this field has been populated will now be tied to this CustomerID + CustomerChildID combination. Just as Customers cannot see data created by other Customers, so too a Customer's Children will not be able to see each other's data. A Customer can see the documents/entities and checks of all their Children.

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.

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

The request was valid and was successfully processed. The onboarding URL has been returned.

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 nullformat: "ulid"

Unique identifier for every request. Can be used for tracking down answers with technical support.

Uses the ULID format (a time-based, sortable UUID)

Note: this will be different for every request.

1	import requests
2
3	url = "https://api.kycaml.uat.frankiefinancial.io/compliance/v1.2/business/onboarding-url"
4
5	payload = { "flowId": "example-flow-id" }
6	headers = {
7	"X-Frankie-CustomerID": "X-Frankie-CustomerID",
8	"api_key": "<apiKey>",
9	"Content-Type": "application/json"
10	}
11
12	response = requests.post(url, json=payload, headers=headers)
13
14	print(response.json())

1	{
2	"url": "https://verify.uat.frankie.one/v2/?t=shortToken",
3	"urlExpiry": "2020-01-01T00:00:00.000Z",
4	"requestId": "01BFJA617JMJXEW6G7TDDXNSHX"
5	}

Authentication

Headers

Request

Response

Errors