Pix Key Validation Endpoint

Validate Pix Keys in real time by using the Pix Key Validation Endpoint

Account Validation Request

POST https://api-stg.directa24.com/v5/account/pix_key/validate

This endpoint allows you to validate if a Pix Key exists and is valid.

Check with your TAM regarding the production API endpoint.

Headers

Name	Type	Description
Content-Type*	string	application/json
X-Date*	string	ISO8601 Datetime with Timezone: yyyy-MM-dd'T'HH:mm:ssZ
X-Login*	string	Merchant X-Login Cashouts API Key
Authorization*	string	Authorization control hash

Request Body

Name	Type	Description
pix*	String	JSON Array containing the list of Pix Keys to check in one request

200: OK Success

[
    {
        "pix": "29318456719",
        "valid": true
    },
    {
        "pix": "31379789206",
        "valid": false
    },
    {
        "pix": "[e-mail]",
        "valid": false
    },
    {
        "pix": "551234512341",
        "valid": true
    }
]

401: Unauthorized Invalid Credentials

{
    "code": 100,
    "description": "Invalid Credentials",
    "type": "INVALID_CREDENTIALS"
}

Description

This endpoint allows you to verify whether a Pix Key exists or not, preventing users from registering an invalid Pix Key on your website.

All Pix Key types can be verified with this API.

In order to start using this API, you need to:

1. Send the request with POST method.

2. Use the headers described here.

3. Specify the pix key(s) in the body of the request as a JSON array. Each object within the array should contain a key "pix" with a corresponding string value.

Example body with multiple Pix keys

[
    {
        // This is Pix Key of type CPF
        "pix": "29318456719"
    },
    {
        // This is a Pix Key of type CPF
        "pix": "31379789206"
    },
    {
        // This is a Pix Key of type Email
        "pix": "[e-mail]"
    },
    {
        // This is a Pix Key of type Phone number
        "pix": "551234512341"
    }
]

This API must be activated on your account. Check with your Account Manager regarding the activation

Example Responses

Success Example

In case the Pix Keys is valid, a boolean field called "valid" will be returned for each Pix Key with either true/false.

[
    {
        "pix": "29318456719",
        "valid": true
    },
    {
        "pix": "31379789206",
        "valid": false
    },
    {
        "pix": "[e-mail]",
        "valid": false
    },
    {
        "pix": "551234512341",
        "valid": true
    }
]