For the complete documentation index, see llms.txt. This page is also available as Markdown.

How do I create an application in Draft status?

By default, Bead creates and submits onboarding applications immediately so the signer can begin the signing flow. This preserves the standard behavior for existing integrations.

If you need to upload supporting documents before the application is sent for signing, create the application in Draft status by setting:

{  "submitImmediately": false}

Use this flag when calling the application creation endpoint:

POST /merchant-onboarding/applications

or, if using the minimal application flow:

POST /merchant-onboarding/applications-short

When submitImmediately is set to false, Bead creates the application but does not immediately move it into the signing flow. The returned applicationId can then be used to upload supporting documents while the application remains in Draft status.

Example:

{  "submitImmediately": false,  "signerInfo": {    "name": "Morgan Reed",    "email": "morgan@example.com",    "position": "Owner"  },  "merchantData": {    "registeredName": "Northwind Coffee Roasters LLC"  }}

After the application is created in Draft status, upload any required attachments to the application.

When all attachments are complete, submit the Draft application using:

POST /merchant-onboarding/applications/{applicationId}/submit

After this command is called, the application moves forward into the signing flow. Attachments can only be added while the application is still in Draft status.

Related documentation:

Submit Application – Submit behavior

Last updated