APIs
Sub-processorsAbout PismoContact us

Create key entry

post
https://sandbox.pismolabs.io/pix-dict/v2/pix/keys

Creates a new DICT key entry for the user.

The Banco Central do Brazil (BCB) maintains Pix keys in the Diretório de Identificadores de Contas Transacionais (DICT), a national Pix key registry and database.

On PSP timeout, a 202 Accepted with a key status = PROCESSING reponse is returned and the process continues asynchronously, eventually emitting a success or error event.

This endpoint generates a Pix key status changed event.

For more information, refer to the Pix instant payments guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Create a new key

string
required
length ≤ 77

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

string
enum
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.
Allowed:
string
enum
required

Reason for entry creation

Allowed:
bank_account
object
required
string
enum

Name type:

  • REGISTRATION_NAME - Name assigned at birth
  • SOCIAL_NAME - Preferred name, not necessarily REGISTRATION_NAME
Allowed:
Headers
string
required

Account token - token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a 401 Unauthorized message.

string
required

A unique UUID identifier to ensure the operation remains idempotent, allowing for operation repitition without causing unintended effects or duplication. An idempotent operation is one that can be applied multiple times, yet the outcome remains the same. it ensures that network errors, retries, or failures can occur without introducing inconsistencies.

Responses

Updated 4 days ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago