PIpismo
Keys

Check DICT keys

Check that a list of key(s) exist in DICT, a Brazilian national Pix registery and database. Keys can be generated from an email address, a mobile phone number, a Tax ID number, or an EVP (virtual payment address).

post/v2/pix/keys/check

Request

  • Base URL
    https://sandbox.pismolabs.io/pix-dict
  • URL
    https://sandbox.pismolabs.io/pix-dict/v2/pix/keys/check
  • Auth
    HTTP bearer

Headers

x-tenantstring required

Organization/tenant ID

x-cidstring

The Correlation IDentifier UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

x-account-idstring

Pismo account ID

Request body

Example request

{
  "keys": [
    {
      "key": "mason.jarr@example.com"
    }
  ]
}

Response

CheckResponse Body

Example response

{
  "keys": [
    {
      "key": "nan_obyte@email.com"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.