Skip to main content

Set Main Bank Account


Introduction​

This resource sets (or removes) a bank account as the investor's main account within a registration analysis. Only one account can be marked as main at a time — when an account is marked as main, the previously main account is automatically unmarked.

Available on
ProfileHost
Distributordistributor-api

Base URL for each host: Environments (Hosts).

Request​

ENDPOINT
/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/bank_account/{external_bank_account_key}/default
METHOD
PUT
STATUS
202

Request body​

Request Body
{
"value": true
}

Body params​

FieldTypeDescriptionRequired
valuebooleantrue to set this account as mainYes

Response​

202 Accepted. The updated representation of the account is returned in the body.

Errors​

StatusCodeWhen it happens
400IVR000185The analysis has already been closed (approved, rejected, completed or canceled)
404IVR000181Account not found for the external_bank_account_key
400IVR000193An inactive account cannot be the main account

Authentication, permission and host errors: see API Errors.