Create an application

POST

/api/v1/applications

Authorizations

• apiKey

Request Body ^required

object

type

required

string

Allowed values: individual business

firstName

required

string

Example

John

lastName

required

string

Example

Doe

email

required

string

Example

john.doe@example.com

sendEmail

required

boolean

manual

Skips external data sources (ID verification, KYC/KYB checks, and screening). Set at creation only; not editable afterward.

boolean

businessName

Name of the business (optional, can be provided for any application type)

string

Example

Acme Corporation

workflowId

ID of the workflow to use for this application

string

Example

507f1f77bcf86cd799439011

prefillApplicationId

ID of an existing application to pre-fill default values from

string

Example

507f1f77bcf86cd799439011

onboardingMode

Onboarding experience mode (CLASSIC wizard or DYNAMIC chat). Defaults to CLASSIC.

string

Allowed values: CLASSIC DYNAMIC

reviewPrefilledSteps

Dynamic onboarding: present steps already fully completed by document prefill once, prefilled, for the applicant to review. When false they are backfilled into the transcript as completed history cards. Defaults to true, matching the account-level default.

boolean

default: true

Example

true

skipPrefilledSteps

Deprecated — use reviewPrefilledSteps (this field is its inverse). Ignored when reviewPrefilledSteps is supplied.

boolean

skipOnboardingWelcome

Dynamic onboarding: begin the chat automatically instead of presenting the welcome screen. Not surfaced in any UI — intended for programmatic creation flows whose profiles arrive prefilled (application migration). Defaults to false.

boolean

deferRequirements

Dynamic onboarding: when true, every required field is treated as optional — the applicant can complete onboarding with whatever information is available and submit with fields left blank. Each skipped field becomes a self-clearing follow-up Review. Defaults to false.

boolean

hasSubscriptionDocument

Whether a subscription document was attached at creation to prefill the application. Recorded on the creation audit-log entry; the document itself is uploaded separately after the application is created.

boolean

metadata

Arbitrary key-value metadata. Up to 50 key-value pairs. Keys: 1-40 chars, letters/digits/hyphens/underscores only. Values: strings up to 500 chars.

object

key

additional properties

string

Example

{
  "externalRef": "abc-123",
  "plan": "enterprise"
}

Responses

201

object

id

required

string

Example

507f1f77bcf86cd799439012

Example

{
  "id": "507f1f77bcf86cd799439012"
}