Create account request

POST

/order/v1/banking/accounts

• Production
• Sandbox

Create a banking account request with holder information and representatives.

Authorizations

• Bearer

Parameters

Header Parameters

idempotency-key

required

string

Unique key for idempotent requests

Request Body ^required

object

country

required

Holder country code in ISO-3

string

Allowed values: BRA

Example

BRA

holderType

required

Holder type

string

Allowed values: INDIVIDUAL ORGANIZATION

Example

ORGANIZATION

fullName

required

Holder full name or business name. An INDIVIDUAL holder must send the complete name, at least a first and a last name.

string

Example

Company LTDA

email

required

Primary email of the holder.

string

Example

[email protected]

phone

required

Primary phone of the holder.

string

Example

+5511912349865

birthdate

required

Holder birthdate or foundation date (YYYY-MM-DD). An INDIVIDUAL holder must be at least 18 years old; accounts for a minor or a legally incapable holder are not supported.

string

Example

1990-01-01

document

required

Holder identification document.

object

type

required

Document type.

string

Allowed values: CPF CNPJ RUC NATIONAL_ID PASSPORT FOREIGNER_ID CHANCERY_ID CEDULA_DE_CIUDADANIA CEDULA_DE_EXTRANJERIA NUMERO_DE_IDENTIFICACION_TRIBUTARIA OTHERS DNI CURP RFC

Example

CNPJ

number

required

Document number (digits and uppercase letters for alphanumeric CNPJ).

string

Example

11222333000181

address

required

Complete holder address. For an INDIVIDUAL holder this is the residential address.

object

street

required

Street and number.

string

Example

Av Paulista, 1636

neighborhood

required

Neighborhood.

string

Example

Bela Vista

city

required

City.

string

Example

Sao Paulo

state

required

State (UF).

string

Example

SP

zipCode

required

ZIP code (digits only).

string

Example

01310100

complement

Address complement.

string

Example

Block B

representatives

Representatives linked to the holder. Required when holderType is ORGANIZATION and refused when it is INDIVIDUAL, where the holder is the person themselves.

Array<object>

object

country

required

Representative country in ISO-3.

string

Allowed values: AFG ALB DZA ASM AND AGO AIA ATA ATG ARG ARM ABW AUS AUT AZE BHS BHR BGD BRB BLR BEL BLZ BEN BMU BTN BOL BES BIH BWA BVT BRA IOT BRN BGR BFA BDI CPV KHM CMR CAN CYM CAF TCD CHL CHN CXR CCK COL COM COG COD COK CRI HRV CUB CUW CYP CZE DNK DJI DMA DOM ECU EGY SLV GNQ ERI EST ETH FLK FRO FJI FIN FRA GUF PYF ATF GAB GMB GEO DEU GHA GIB GRC GRL GRD GLP GUM GTM GGY GIN GNB GUY HTI HMD VAT HND HKG HUN ISL IND IDN IRN IRQ IRL IMN ISR ITA JAM JPN JEY JOR KAZ KEN KIR PRK KOR KWT KGZ LAO LVA LBN LSO LBR LBY LIE LTU LUX MAC MDG MWI MYS MDV MLI MLT MHL MTQ MRT MUS MYT MEX FSM MDA MCO MNG MNE MSR MAR MOZ MMR NAM NRU NPL NLD NCL NZL NIC NER NGA NIU NFK MNP NOR OMN PAK PLW PSE PAN PNG PRY PER PHL PCN POL PRT PRI QAT REU ROU RUS RWA BLM SHN KNA LCA MAF SPM VCT WSM SMR STP SAU SEN SRB SYC SLE SGP SXM SVK SVN SLB SOM ZAF SGS SSD ESP LKA SDN SUR SJM SWE CHE SYR TWN TJK TZA THA TLS TGO TKL TON TTO TUN TUR TKM TCA TUV UGA UKR ARE GBR USA UMI URY UZB VUT VEN VNM VGB VIR WLF ESH YEM ZMB ZWE

Example

BRA

fullName

required

Representative full name.

string

Example

John Test

email

required

Representative email.

string

Example

[email protected]

phone

required

Representative phone number.

string

Example

+5511912349865

birthdate

required

Representative birthdate (YYYY-MM-DD).

string

Example

1990-01-01

documentNumber

required

Representative document number (CPF).

string

Example

52998224725

alias

Label that identifies this account among the accounts of the same holder. Send a different alias for each additional account opened for the same document; when omitted the account is created as “primary”.

string

Example

settlement

Responses

200

The resource was returned successfully

object

accountRequestId

required

Identifier of the account creation request.

string

Example

d3f46d1e-3f35-4cf9-9bcb-15c0b7c8f84a

status

required

Current status of the account creation request.

string

Example

PENDING

400

object

error

string

Example

INVALID_REQUEST

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[
  {
    "field": "field_name",
    "issue": "INVALID",
    "description": "Field is invalid"
  }
]

401

Unauthorized Request

object

error

string

Example

UNAUTHORIZED

message

string

Example

Unauthorized Request

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

403

object

error

string

Example

FORBIDDEN_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]

500

object

error

string

Example

INTERNAL_ERROR

message

string

details

Array<object>

object

field

string

issue

string

description

string

Example

[]