API Reference
  1. Platform
  2. Onboarding

Create onboarding record

post
https://{hostname}/api/v1/platform/onboard

Submits a new company's business and owner details for onboarding.
Returns a companyId you can use to retrieve the onboarding status
or to update details later.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The onboarding submission for a new or existing company.

businessInfo
object
required

The business details for an onboarding submission.

owners
array of objects
required
length ≥ 1

The beneficial owners of the business. At least one is required.

owners*
string
required

The IP address of the person submitting this onboarding, captured for compliance.

string
required

The user agent of the person submitting this onboarding, captured for compliance.

Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
UUID
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?