Business Onboarding

Business Onboarding is a hosted flow that guides applicants through providing the information needed to verify an organisation. You generate a time‑limited URL and redirect your user to complete the steps.

How it works

• Generate a hosted URL using your flowId.
• Redirect the applicant’s browser to the returned URL.
• The applicant completes the onboarding pages and submits.
• Verification URL for identified owners can be sent from the flow.
• Redirect after completion can be configured (CTA target on the End page).

Generate a hosted URL

Use the Hosted URL endpoint to create a URL for a new onboarding session.

1
POST /v2.1/organizations/hostedUrl
2
Host: api.uat.frankie.one

Headers

• api_key: Your FrankieOne API key
• X-Frankie-CustomerID: Your Customer ID
• X-Frankie-CustomerChildID: Child tenant identifier

Request body

1
{
2
  "flowId": "example-flow-id"
3
}

Sample request (UAT)

$
curl --request POST \
>
  --url https://api.uat.frankie.one/v2.1/organizations/hostedUrl \
>
  --header 'api_key: <YOUR_API_KEY>' \
>
  --header 'X-Frankie-CustomerID: <YOUR_CUSTOMER_ID>' \
>
  --header 'Content-Type: application/json' \
>
  --data '{
>
    "flowId": "<your-flow-id>"
>
  }'

Sample response

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

Pages in the flow

Below are the standard pages included in the hosted flow. Availability and fields depend on your configured flowId and the selected organisation type.

• Start page Intro screen to begin a new application.

  

• Applicant details Captures the applicant’s name, role, contact details, and consent. The Terms & Conditions checkbox message can be customised.

  

• Lookup Search by organisation name, ABN or ACN. On submission, the flow runs an Ownership query on the selected organisation to determine structure and required next steps.

  

• Additional details Fully customisable fields (labels, required/optional) for business context, e.g. source of wealth/capital, industry, purpose, contact details.

  

• Organisation details Prefilled from registry/profile data where available. Address fields may require confirmation/editing depending on data availability. Applicable to: sole trader, company, and trust organisations.

  

• Document upload Fully customisable document groups and requirements. For trust organisations, the flow adds defaults for Trust Deed, Deeds of Variation, and Register of Unit Holders. Applicable to: company and trust organisations. Sole trader does not include this step.

  

• Owners Displays identified significant owners and directors for confirmation and contact details capture. Applicable to: sole trader and company.

  

• Review Summary of all captured details and documents prior to submission.

  

• End page Confirmation page. The primary CTA can redirect to a configurable URL (e.g. return to your product).

  

Branding and UI customisation

• Logo: Replace with your brand logo.
• Buttons: Configure colour and border radius.
• Copy: Customise explanatory text and T&C/consent copy.
• Fields: Add, remove, or reorder fields on Additional Details and Document Upload pages, including validations and optionality.
• Redirects: Configure the destination for the End page CTA.

Work with FrankieOne to define these in your flow configuration.