Skip to content
Developers
Back to Steward

Create an application

POST
/api/v1/applications

Authorizations

Section titled “ Authorizations ”

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
object
type
required
string
Allowed values: individual business
firstName
required
string
lastName
required
string
email

Applicant email. REQUIRED when sendEmail is true: it is the address the onboarding link goes to. Optional otherwise, for an application a staff member fills in themselves and delivers by other means; that application is created without a submitter until an address is added.

string
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
workflowId

ID of the workflow to use for this application

string
prefillApplicationId

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

string
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
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, so 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
onboardingPath

The onboarding path chosen in the platform create dialog. Reporting context only; API-key callers are always recorded as API.

string
Allowed values: invite self
deliveryAction

The delivery chosen in the platform create dialog. Reporting context only; independent of whether the invitation email succeeds.

string
Allowed values: send-invite create-and-copy-link create
Examples
{
  "type": "individual",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "sendEmail": true,
  "manual": false,
  "businessName": "Acme Corporation",
  "reviewPrefilledSteps": true,
  "skipPrefilledSteps": false,
  "skipOnboardingWelcome": false,
  "deferRequirements": false,
  "hasSubscriptionDocument": false,
  "metadata": {
    "externalRef": "abc-123",
    "plan": "enterprise"
  },
  "onboardingPath": "invite"
}

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”
Media type application/json
object
id
required
string
inviteEmail

Present only when sendEmail was true

object
status
required
string
Allowed values: SENT FAILED
failureCode
string
Allowed values: INACTIVE_RECIPIENT
reason
string
Examples
{
  "id": "507f1f77bcf86cd799439012",
  "inviteEmail": {
    "status": "SENT"
  }
}