Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Keys

Validate key

Validates a key locally (if Pismo holds the ownership of it) or directly in DICT (for external keys). It returns related information along with the end_to_end_id you are required to pass to start a Pix transaction with the Perform pix-out transfer endpoint.

This call should only be used to initate a payment, it does not return key information.

post/v2/pix/keys/validate

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Request body

keystring required

Pix key value.

include_statisticsboolean

Include statistics

Example request

{
  "key": "email@email.com"
}

Response

OK

key_type'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP' required

User information that can be used to create a Pix key:

  • CPF - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US.
  • CNPJ - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil
  • EMAIL - Email
  • PHONE - Phone number
  • EVP - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.
creation_datetimestring date-time

Creation datetime. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

keystring

Pix key value.

end_to_end_idstring

This field is a Brazil Central Bank (BCB) requirement to track all steps of Pix transactions. Basically, there are two steps to a Pix transaction: 1. Initialize a transaction 2. Confirm a transaction The end_to_end_id is sent to the BCB in both steps in order to identify all transaction information.

internalboolean

Is Pismo validating the key internally?

ownership_datetimestring date-time

Ownership date time. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

correlation_idstring

The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header.

claim_requested_datetimestring date-time

Claim requested date time. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

Example response

{
  "bank_account": {
    "participant": "00115678",
    "account_number": "98765432",
    "account_type": "TRAN",
    "branch": "011",
    "opening_datetime": "2020-08-13T13:49:03Z"
  },
  "key_type": "EMAIL",
  "creation_datetime": "2020-08-13T13:49:03Z",
  "key": "email@email.com",
  "key_statistics": {
    "entries": {
      "distinct_accounts": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    },
    "fraud_markers": {
      "application_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "distinct_fraud_reporters": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "mule_accounts": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "other_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "scammer_accounts": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "total_fraud_transaction_amount": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "unknown_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    },
    "infraction_reports": {
      "rejected_reports": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "open_reports": 45,
      "open_reports_distinct_reporters": 34,
      "watermark": "2020-01-17T10:00:00Z"
    },
    "spi": {
      "settlements": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    }
  },
  "end_to_end_id": "E3030629420200808195101608910248",
  "owner": {
    "document_number": "7777888hh",
    "name": "Jerry Atrick",
    "type": "NATURAL_PERSON",
    "trade_name": "Acme Widgets"
  },
  "ownership_datetime": "2020-08-13T13:49:03Z",
  "owner_statistics": {
    "entries": {
      "watermark": "2020-01-17T10:00:00Z"
    },
    "fraud_markers": {
      "application_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "distinct_fraud_reporters": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "mule_accounts": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "other_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "scammer_accounts": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "total_fraud_transaction_amount": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "unknown_frauds": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    },
    "infraction_reports": {
      "open_reports": 45,
      "open_reports_distinct_reporters": 34,
      "rejected_reports": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    },
    "spi": {
      "settlements": {
        "d90": 86,
        "m12": 23,
        "m60": 12
      },
      "watermark": "2020-01-17T10:00:00Z"
    }
  },
  "correlation_id": "c737895c-8159-4c0c-a92a-a4f8600bff37",
  "claim_requested_datetime": "2020-08-13T13:49:03Z"
}