Send Investor Bank Account

---

Introduction

This resource registers a bank account for the investor within a registration analysis. Each account must be sent in a separate request — to register more than one account, call the endpoint multiple times.

Input / Output

As input, send the data of one bank account.

As output, the keys of the created account — bank_account_key and external_bank_account_key — and its status are returned.

Request

ENDPOINT

/investor_registry/investor/{investor_key}/investor_analysis/{investor_analysis_key}/bank_account

METHOD

POST

STATUS

201

Request body

Example: individual main account

Request Body

{
    "financial_institution_code": "341",
    "account_number": "12345678",
    "account_digit": "9",
    "account_branch": "0001",
    "main_account": true
}

Example: joint account

Request Body

{
    "financial_institution_code": "341",
    "account_number": "12345678",
    "account_digit": "9",
    "account_branch": "0001",
    "shared_account_owners": [
        {
            "name": "Maria Silva",
            "document_number": "969.698.790-03"
        }
    ]
}

Body params

Field	Type	Description	Characters	Required
financial_institution_code	string	Financial institution code (COMPE / short ISPB)	1 - 4	Yes
account_number	string	Bank account number (digits only)	1 - 20	Yes
account_digit	string	Account check digit	1	Yes
account_branch	string	Branch number (4 digits)	4	Yes
main_account	boolean	Indicates whether it is the investor's main account	-	No
shared_account_owners	array	List of Shared Account Owner objects	-	No

info

Only one account can be marked as main_account: true. If no account is marked as main, the first one registered is assumed to be the main account.

Shared Account Owners

Field	Type	Description	Characters	Required
name	string	Name of the account co-holder	-	Yes
document_number	string	Co-holder CPF (XXX.XXX.XXX-XX)	14	Yes

Response

Response Body

{
    "bank_account_key": "UUID",
    "external_bank_account_key": "UUID",
    "status": "active"
}

Field	Type	Description
bank_account_key	string	Internal identifier of the created bank account
external_bank_account_key	string	Key used in the account maintenance routes: update data, update status and set main account
status	string	Account status on creation — always active

Errors

Status	Code	When it happens
400	IVR000018	The analysis is no longer in pending_registry_data (it has already been sent or closed)
404	IVR000078	Unknown bank code
409	IVR000077	The account is already registered

Authentication, permission and host errors: see API Errors.