Claim DICT

Route to claim a pix key for a bank account using the unique bank acocunt code

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

❗️

Is necessary to register device on onboarding

Response Parameters


ParametersFormatDescription
returnbooleanresponse status ( true / false )
messageStringResponse message
dataArray of ObjectResponse data
codeStringPix code
typeStringPix type
keyStringPix key
claimedStringPix key claimed (Y/N)

Request Parameters

Path Params
string
required

Bank Account Unique Code

Body Params
string
enum
required
Defaults to cpf

Pix type

Allowed:
string
required
Defaults to 12345678910

Pix key

string
required
Defaults to -11,100, -22,100

Client Geo Localization

string
required
Defaults to 123.123.123.123

Client IP Address

string
required
Defaults to Web - Google Chrome

Client System

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