Create DICT

Route to create a new pix key using the unique bank account code

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

📘

If the key parameter is not passed, we will try to create the key based on the bank account info in our Database. If it is passed, we will try to create the key using the key value.

❗️

Is necessary to register device on onboarding

Pix Key Types

IdentificationDescription
cpfcreate key using cpf
cnpjCreate Key using cnpj
emailcreate key using email
phonecreate key using phone
evpcreate a random key

Response Parameters

ParametersFormatDescription
returnbooleanresponse status ( true / false )
messageStringResponse message
dataObjectResponse data
codeStringPix code
typeStringPix type
keyStringPix key

Request Parameters

Path Params
string
required

Bank Account Code

Body Params
string
enum
required
Defaults to cpf

Pix Type

Allowed:
string
required

Client Geo Localization

string
required
Defaults to 123.123.123.123

Client IP Address

string
required
Defaults to Web - Google Chrome

Client System

string
Defaults to 12345678910

Pix Key

string
required
Responses

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