Consult an Alias Entity

Consult an Alias entity that is already registered to an existing account.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account key.	36
alias_key	uuidv4	Unique alias key.	36

Response

STATUS

200

Response Body

{
  "alias_key": "c446e513-131c-4741-bbc2-b7e6b6282899",
  "ispb": "12345678",
  "account_branch": "0001",
  "account_number": "4968688",
  "account_digit": "3",
  "account_type": "checking_account",
  "account_created_at": "2021-10-22T20:30:23.459Z",
  "owner_person_type": "legal",
  "owner_document_number": "89248771384257",
  "owner_name": " Vinicius De Oliveira",
  "owner_trading_name": "Pix Ltda",
  "created_at": "2021-10-22T20:30:23.459Z"
}

Response Body Params

Field	Type	Description	Max. Characters
alias_key	string	Unique alias key	36
ispb	string	ISPB of the financial institution linked to the Alias	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	20
owner_document_number	string	CPF or CNPJ number	14
owner_name	string	Account owner's name	120
owner_trading_name	string	Account owner's trade name (only for CNPJ)	100
created_at	string	Date the request was made	20

Enumerator account_type

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

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"
}

Response Body: Not found

{
  "title": "Not found", 
  "description": "Alias \{alias_key\} not found", 
  "translation": "Alias \{alias_key\} n\u00e3o encontrado",
  "extra_fields": {}, 
  "code": "ACC000181"
}