Skip to main content
PATCH
Update application

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

The application ID.

Body

Request model for updating an existing bank account application. Uses Tesouro.Common.Types.Rest.Optional&lt;T&gt; for partial-update semantics — see that type for the absent / explicit-null / explicit-value contract.

applicant
null | object

Applicant details to update. Absent = preserve; explicit value = replace; explicit null = clear.

businessDetails
null | object

Business details to update. Absent = preserve; explicit value = replace; explicit null = clear.

businessOwners
null | object[]

List of business owners. Absent = preserve existing owners; explicit null = clear all owners. A non-empty list replaces the stored owner list; an empty array is rejected.

individualValidationSource
string

Validation source for individual KYC (bypass-KYC partners only). Absent = preserve.

organizationValidationSource
string

Validation source for organization KYC (bypass-KYC partners only). Absent = preserve.

Response

Application updated successfully.

Response model for a bank account application.

id
string<uuid>
required

Unique identifier for the bank account application.

applicant
null | object

Applicant information for the bank account.

businessDetails
null | object

Business details associated with the application.

businessOwners
null | object[]

List of business owners associated with the application.

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
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
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.