Register An Own Bank Account
Registers a bank account owned by the authenticated user.
Country restriction: Only available for accounts with country = AR or country = BR.
- AR — accepts a CBU (22 digits), CVU (22 digits), or alias (alphanumeric with dots). Account ownership is validated against an external service before registration. Returns
201if the account is newly registered,200if it was already registered. - BR — accepts a Pix key: e-mail, CPF (11 digits), CNPJ (14 digits), phone in E.164 format, or EVP (UUID). Ownership is validated before registration. Returns
201if the key is new,200if it already exists.
Throttling: Maximum 5 requests per minute and 20 requests per hour per user.
Domain error codes (returned inside data.detail[]):
BANK_0001— the account does not belong to the authenticated user.BANK_0002— conflict; the operation cannot be completed.BANK_0003— the external validation service is temporarily unavailable.
Authorization
- Requires a valid API key.
Headers
The API key as a string.
See the Generating Signature section for more details.
A timestamp in milliseconds. See the Timestamp Security section for more details.
An additional, non-required parameter, that you can send to specify the number of milliseconds after the timestamp for the request to be valid. See the Timestamp Security section for more details.
Body
The account identifier to register:
- AR: CBU (22 digits), CVU (22 digits), or alias (alphanumeric with dots).
- BR: Pix key — e-mail, CPF (11 digits), CNPJ (14 digits), phone (E.164), or EVP (UUID).
"mi.cuenta.alias"