Pix keys validator

Validate one or more Pix Keys

post

This endpoint allows you to verify whether a Pix Key exists or not. All Pix Key types can be verified with this API.

Header parameters

Content-TypestringRequired

Media type of the request.

Example: application/json

X-Datestring · date-timeRequired

ISO8601 Datetime with Timezone.

Example: 2023-10-27T10:00:00Z

X-LoginstringRequired

Merchant X-Login Cashouts API Key.

AuthorizationstringRequired

Authorization control hash.

Bodyobject · PixKey[]

application/json

pixstringRequired

The Pix Key to validate (e.g., CPF, Email, Phone Number).

Example: 29318456719

Responses

200

OK - A list of validation results for each submitted Pix Key.

application/json

pixstringOptional

The Pix Key that was validated.

validbooleanOptional

Indicates if the Pix Key is valid.

401

Unauthorized - The provided credentials are not valid.

application/json

post

/account/pix_key/validate

HTTPcURLJavaScriptPython

POST /v5/account/pix_key/validate HTTP/1.1
Host: api-stg.onekeypayments.com
X-Date: 2023-10-27T10:00:00Z
X-Login: text
Authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 100

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

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