Qodex.ai

Create a Pix key

POST {{baseInfraUrl}}/{{version}}/pix-key

Create a Pix Key linked to a specific account.

ParametersValue TypeDescription
accountCreatedREQUIREDOpening Date or DateTime for the account linked to the Pix Key. Example: accountCreated=2022-01-01
accountNumberREQUIREDNumber of the account linked to the Pix Key. Example: accountNumber=76543.
accountTypeREQUIREDType of the account linked to the Pix Key. Options: checking, savings, salary and payment.
branchCodeREQUIREDBranch code of the account linked to the Pix Key. Example: branchCode=1234.
nameREQUIREDAccount holder's name of the account linked to the Pix Key. Example: name=Jamie Lannister.
taxIdREQUIREDAccount holder's taxId (CPF/CNPJ) of the account linked to the Pix Key. Example: taxId=012.345.678-90.
idOPTIONALId of the registered Pix Key. Allowed types are: CPF, CNPJ, phone number or email. If this parameter is not passed, an EVP will be created. Example: +5511989898989
tagsOPTIONALList of strings to tag the entity for future queries. All tags will be converted to lowercase. Example: tags=[iron, bank].

Request Body

{"accountCreated"=>"2022-02-01", "accountNumber"=>"0000", "accountType"=>"savings", "branchCode"=>"0000", "id"=>"+5511989898989", "name"=>"Jamie Lannister", "taxId"=>"012.345.678-90"}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"key":{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"0000","accountType":"savings","bankCode":"35547753","bankName":"","branchCode":"0000","created":null,"id":"+551196969696","name":"Jamie Lannister","owned":null,"ownerType":"individual","status":"created","tags":[],"taxId":"012.345.678-90","type":"phone"},"message":"Key registration successfully requested."}