PIpismo
Keys

Get key

Searches for a DICT key entry returning the owner information.

post/v2/pix/keys/search

Request

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

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - 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

Value, based on a key's type, used to encrypt Pix key.

Example request

{
  "key": "al_fresco@bourdain.com"
}

Response

OK

org_idstring

Organization/tenant ID.

account_idstring

Pismo account ID

keystring required

Value, based on a key's type, used to encrypt Pix key.

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 required

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

ownership_datetimestring date-time

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

correlation_idstring uuid

The correlation identifier is used to link related API requests and events. The Pismo engineering team can use this to track everything related to a call. If one is not passed, it is automatically generated and returned to the client in a 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

{
  "org_id": "TN-34778262-f4f0-464d-b4c6-a14e2dc6f4be",
  "account_id": "8675309",
  "key": "al_fresco@bourdain.com",
  "key_type": "EMAIL",
  "bank_account": {
    "participant": "00115678",
    "account_number": "98765432",
    "account_type": "TRAN",
    "branch": "011",
    "opening_datetime": "2020-08-13T13:49:03Z"
  },
  "owner": {
    "document_number": "123412341234",
    "name": "Jerry Atrick",
    "type": "NATURAL_PERSON",
    "trade_name": "Acme Widgets"
  },
  "creation_datetime": "2020-08-13T13:49:03Z",
  "ownership_datetime": "2020-08-13T13:49:03Z",
  "correlation_id": "ea8bc045-9ff7-439f-a318-2e6f974707a5",
  "claim_requested_datetime": "2020-08-13T13:49:03Z"
}

Changes

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