Skip to main content

Update Bank Account Status


Introduction​

This resource changes the status of a bank account previously registered in a registration analysis — for example, to deactivate an account that should no longer be used.

The account is identified by its external key (external_bank_account_key), returned on creation.

Request​

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

Request body​

Request Body
{
"status": "inactive"
}

Body params​

FieldTypeDescriptionRequired
statusstringNew status of the account. Typical values: active, inactiveYes

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
400IVR000075Invalid status value
400IVR000074The main account cannot be deactivated

Authentication, permission and host errors: see API Errors.