Creation of an Alias Entity

This flow is responsible for creating Alias entities, linked to an existing account.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias

METHOD

POST

Request Body

{
    "request_control_key":"5b4259a4-dc4a-489f-a050-3391e13d9850",
    "account_branch": "0001",
    "account_number": "4968698",
    "account_digit": "3",
    "account_type": "checking_account",
    "account_created_at": "2022-09-24T19:46:43.001Z",
    "owner_person_type": "legal",
    "owner_document_number": "89248771384257",
    "owner_name": "Vinicius De Oliveira",
    "owner_trading_name": "Pix Ltda"
}

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account key.	36

Request Body Params

Field	Type	Description	Max. Characters
request_control_key *	string	Unique identification key for the request used by the client in uuidv4 format	36
account_branch *	string	Branch, without the check digit	4
account_number *	string	Account number, without the check digit	20
account_digit *	string	Account check digit	1
account_type *	enumerator	Account type	Enumerator account_type
account_created_at *	string	Account creation date. Ex: "2022-09-24T19:46:43.001Z"	20
owner_document_number *	string	CPF or CNPJ number	11 (CPF) or 14 (CNPJ)
owner_person_type *	string	Account owner type. Can be legal or natural	7
owner_name *	string	Account owner's name	120
owner_trading_name	string	Account owner's trade name (optional, and only for CNPJ)	100

Enumerator account_type

Enumerator	Description
checking_account	Conta Corrente
salary_account	Conta Salário
saving_account	Conta Poupança
payment_account	Conta de Pagamentos

Response

STATUS

201 created

Response Body

{
  "alias_key": "e04f496b-47be-4762-a6e2-8f2b05b46780",
  "created_at": "2022-09-24T19:46:43.001Z"
}

Response Body Params

Field	Type	Description	Max. Characters
alias_key	uuidv4	Unique alias key	36
created_at	datetime Zulu	Date the request was made	20

STATUS

404

Response Body: Not Found

  {
    "title": "Not Found", 
  "description": "Account not found for the given key \{account_key\}", 
  "translation": "A account_key \{account_key\} não foi encontrada",
  "extra_fields": {}, 
  "code": "ACC000006"
}

STATUS

400

Response Body: Repeted Request Control Key

  {
  "title": "Repeated Request Control Key", 
  "description": "The request_control_key sent \{request_control_key\}, was already been used in other requisition", 
  "translation": "A request_control_key enviada \{request_control_key\}, já foi utilizada em outra requisição",
  "extra_fields": {}, 
  "code": "ACC000179"
}

Response Body: Invalid owner trading name

  {
  "title": "Bad Request", 
  "description": "The owner_trading_name can only be sent by a legal person type", 
  "translation": "O owner_trading_name s\u00f3 pode ser utilizado por uma pessoa jur\u00eddica",
  "extra_fields": {}, 
  "code": "ACC000180"
}