Skip to main content
POST
Create application

Authorizations

Authorization
string
header
required

Application (M2M) OAuth2 access token (client credentials).

Scopes

bank_account_application:write:org

Submit and manage applications to open new bank accounts within your organization.

Headers

X-Organization-ID
string<uuid>

ID of the organization to perform this operation on behalf of. Required for BANK and PLATFORM app token callers targeting a specific organization. If omitted, the request uses the authenticated caller's own organization. Must be a valid non-empty UUID. Present but malformed values return 400.

Body

Request model for creating a new bank account application.

applicant
null | object

Optional applicant details for the bank account application.

bankRequirements
null | object

Declares the version of its bank's application requirements the application is answered against, named in requirementsVersion, with answers to any questions that version asks beyond the core application. Omit it to answer against the bank's current minimum version, which GET /embedded-banking/v1/bank-account-applications/requirements lists. A version can be declared from the day it is published until the day the next version takes effect, and only by applications to the bank it belongs to; once superseded, it fails with BANK_REQUIREMENTS_VERSION_NOT_ACCEPTED. Answers for an owner name the owner by the id a response gives it, so they can be given only on update; any ownerId here fails with the question error code UNKNOWN_OWNER.

businessDetails
null | object

Optional business details for the bank account application.

businessOwners
null | object[]

Optional list of business owners to add to the application.

individualValidationSource
null | string

Name of the identity verification provider used for the individual. Used by partners who perform their own KYC (know your customer) checks.

organizationValidationSource
null | string

Name of the business verification provider used for the organization. Used by partners who perform their own KYB (know your business) checks.

Response

Application created successfully.

id
string<uuid>
required

Unique identifier for the bank account application.

createdAt
string<date-time>
required

When the application was started (UTC).

updatedAt
string<date-time>
required

When the application was last saved (UTC).

applicant
null | object

Applicant information for the bank account.

bankRequirements
null | object

The version of its bank's application requirements the application is answered against, named in requirementsVersion, with its answers to any questions the bank asks beyond the core application. An answer to a question whose askWhen does not hold is left out, and returned again once the condition holds. GET /embedded-banking/v1/bank-account-applications/{id}/requirements lists that version's questions.

businessDetails
null | object

Business details associated with the application.

businessOwners
null | object[]

List of business owners associated with the application.

clientSecret
null | string
deniedAt
null | string<date-time>

When the application was denied (UTC). Null unless the status is DENIED, and for applications denied before decline times were recorded.

kycVerificationStatus
null | enum<string>

Outcome of the identity/business (KYC) verification for the application, or null when verification has not started. May be non-null before submission: bypass-KYC providers have this pre-approved at creation while the application is still in DRAFT.

Available options:
PENDING,
MANUAL_REVIEW,
APPROVED,
DENIED,
DOCUMENT_VERIFICATION_REQUIRED
organizationId
null | string<uuid>

Identifier of the organization the application has been onboarded under. Null until the application has been verified and the organization created.

status
enum<string>

Current status of the bank account application.

Available options:
DRAFT,
SUBMITTED,
COMPLETE,
DELETED,
CANCELED,
DENIED
submittedAt
null | string<date-time>

When the application was submitted (UTC). Null until it is submitted, and for applications submitted before submit times were recorded.

userId
null | string<uuid>

Identifier of the user created for the applicant during onboarding. Null until the application has been verified and the user created.