Lists PIX keys for Bank Account

Params (Query Params)

Parameter	Value	Description	Example
account_branch_identifier	Number	This field should be filled with the branch number you wish to inquire about. Branch numbers always consist of 4 digits.	Ex: 0001
account_number	Number	In this field, you should fill in the bank account number you wish to inquire about. A bank account number does not have a specific pattern and may vary in length depending on the financial institution. (Example: Accounts registered with SaQ.Digital typically have 6 characters).	Ex: 401050

Headers

Parameter	Type	Description	Example
Authorization	String	Bearer + Access_token	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzEzMzAwOTMxLCJpYXQiOjE3MTMyOTczMzEsImp0aSI6Ijc2ZWI4ZTE5ZjM4YjQ4NmZiODdmNzNjNTdkMWVmNDJhIiwidXNlcl9pZCI6MjQ2fQ.5zekMa7CUj9p-MvNHns5ke4ZPhYV3Y1CLOsYL7hDUUo

Response Details

{
    "worked": true,
    "keys": [
        {
            "key": "dccd9074-XXXX-XXXXX-2328xxxxxx04",
            "name_account": "xx XXXXXXE LTDA",
            "document_account": "51***4290001**"
        },
        {
            "key": "xxxxxxbe-1487-XXXX-XXXXX--c821xxxxx00f",
            "name_account": "GK XXXXXX LTDA",
            "document_account": "51***42xxx01**"
        }
    ]
}

Field	Description
worked	Returns true or false confirming whether the query was successfully returned or not
key	This field returns the PIX key associated with the consulted account. Here are the types of PIX keys with their respective character lengths: Random (EVP Method): This key is randomly generated by the system and can contain up to 36 alphanumeric characters. It's a convenient option for those who don't wish to expose personal information, such as CPF or phone number. Ex: dcce9074-132f-4bf9-a873-232851c818c48 CPF/CNPJ: This key uses the CPF (Individual Taxpayer Registry) or CNPJ (National Registry of Legal Entities) number and has 11 or 14 digits, respectively. It's an option for those who want to use the document number as identification. Ex: CPF: 45831389030 CNPJ: 54977478000103 Email: This key uses the user's email address and can contain up to 180 characters, following the standard email address format. Ex: [email protected] Phone: This key uses the user's cellphone number and has 13 digits (including country code, area code, and number). Ex: 5511990028754
name_account	Returns the information of the account holder's name, according to the registration (onboarding process).
document_account	Returns the document associated with the bank account. It can be the CPF (individual) or the CNPJ (legal entity). This value is not completely exposed for security reasons.