Consult Alias by Request Control Key

Return of the alias_key obtained in the creation of an Alias, using the request_control_key originally assigned to it in the body of the original request.

Request

ENDPOINT

/account/ACCOUNT_KEY/alias

METHOD

GET

Path Params

Field	Type	Description	Characters
account_key	uuidv4	Unique account key.	36

Query Params

Field	Type	Description	Characters
request_control_key *	uuidv4	UUID4 for querying about the made request.	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	Checking Account
salary_account	Salary Account
saving_account	Savings Account
payment_account	Payment Account

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

404

Response Body: Request Control Key Not found

{
  "title": "Request Control Key Not found",
  "description": "The informed request_control_key \{request_control_key\} has no original registered entry associated",
  "translation": "A request_control_key informada \{request_control_key\} n\u00e3o possui entrada original associada",
  "extra_fields": {},
  "code": "ACC000186"
}