Skip to main content
POST
/
embedded-banking
/
v1
/
bank-accounts
Create a new bank account.
curl --request POST \
  --url https://api.sandbox.tesouro.com/embedded-banking/v1/bank-accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "<string>",
  "beneficialOwnerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountNumber": "<string>",
  "createdDateTime": "2023-11-07T05:31:56Z",
  "routingNumber": "<string>",
  "status": "ACTIVE",
  "nickname": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

Request model for creating a new bank account.

​
nickname
string
required

The nickname for the new bank account.

​
beneficialOwnerId
null | string<uuid>

The ID of a beneficial owner to use for VSP APP token bank account creation. Required for VSP APP token callers (no user context). Not applicable when organizationId is provided by BANK or PLATFORM callers.

​
organizationId
null | string<uuid>

Organization ID override for BANK and PLATFORM callers only. When provided by a BANK or PLATFORM app token, creates a bank account for the specified embedded user organization instead of requiring a beneficialOwnerId. Not supported for VSP or user token callers.

Response

Bank account created successfully.

Response model for a bank account.

​
id
string<uuid>
required

Unique identifier for the bank account.

​
accountNumber
string
required

Masked account number.

​
createdDateTime
string<date-time>
required

The UTC timestamp when the bank account was created.

​
routingNumber
string
required

Bank routing number.

​
status
enum<string>
required

The status of the bank account.

Available options:
ACTIVE,
CLOSED
​
nickname
null | string

Nickname for the bank account.