Consult pix key info

Headers

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

Body Details

{
    "source_account_branch_identifier": "0001",
    "source_account_number": "000001",
    "key": "14*******47"
}

Field	Description
source_account_branch_identifier	source_account_branch_identifier: In this field, you should provide the number of the originating bank branch from which the money will be withdrawn. The branch number always consists of 4 digits (e.g., 0001).
source_account_number	In this field, you should provide the bank account number from which the money will be withdrawn. 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).
key	The PIX, Brazilian instant payment system, allows the generation of different types of keys for recipient identification. 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

Response details

{
    "status": 200,
    "data": {
        "chave": "14*******47",
        "tipoChave": 0,
        "nomeCorrentista": "Fulano de tal",
        "nomeFantasia": "",
        "tipoPessoa": 1,
        "documentoFederal": "***815687**",
        "banco": {
            "descricao": "SAQ BANK",
            "numero": "",
            "ispb": "30306294"
        },
        "detalhesConsulta": null,
        "ticket": "",
        "sucesso": true,
        "mensagem": "",
        "key": "14*******47",
        "owner": {
            "name": "Fulano de tal",
            "taxIdNumber": "***815687**"
        },
        "account": {
            "bankName": "SAQ BANK"
        }
    }
}

Field	Type	Description
status	String	Returns status confirming whether the query was successfully returned or not
chave	String	The pix key consulting
tipoChave	Decimal	0 = CPF 1 = CNPJ 2 = CELL_PHONE 3 = EMAIL 4 = EVP
nomeCorrentista	String	Returns the full name of the owner pix key
nomeFantasia	String	Field used to store the trade name associated with a Pix key registered to a company
documentoFederal	String	Returns the document number of owner pix key, either an individual (PF) or a company (PJ).
tipoConta	Decimal	1 = CURRENT 2 = SAVINGS 3 = PAYMENT 4 = SALARY
descricao	String	Bank name owner account
numero	String	Deprecated field — it will be removed soon.
ispb	String	Returns the ISPB code associated with the owner account bank
detalhesConsulta	String	Deprecated field — it will be removed soon.
ticket	String	Deprecated field — it will be removed soon.
sucesso	Stringm	Deprecated field — it will be removed soon.
mensagem	String	Deprecated field — it will be removed soon.
key	String	Deprecated field — it will be removed soon.