Create a Pix claim
POST {{baseInfraUrl}}/{{version}}/pix-claim
Create a Pix Claim to request the transfer of a Pix Key to an account hosted at other Pix participants. There are two distinct Pix Claim types.
An ownership Pix Claim is a request to change the holder of a Pix Key. These Pix Claims can only be requested for Pix Keys with phone or email keyTypes.
A portability Pix Claim is a request to change the account liked to a Pix Key without changing its holder. These Pix Claims can be requested for Pix Keys with phone, email or taxId (CPF/CNPJ) keyTypes.
| Parameters | Value Type | Description |
|---|---|---|
| accountCreated | REQUIRED | Opening Date or DateTime for the account claiming the Pix Key. Example: accountCreated=2022-01-01 |
| accountNumber | REQUIRED | Number of the account claiming the Pix Key. Example: accountNumber=76543. |
| accountType | REQUIRED | Type of the account claiming the Pix Key. Options: checking, savings, salaryand payment. |
| branchCode | REQUIRED | Branch code of the account claiming the Pix Key. Example: branchCode=1234. |
| name | REQUIRED | Account holder's name of the account claiming the Pix Key. Example: name=Jamie Lannister. |
| taxId | REQUIRED | Holder's taxId (CPF/CNPJ) of the account claiming the Pix Key. Example: taxId=012.345.678-90. |
| keyId | REQUIRED | Id of the registered Pix Key to be claimed. Allowed keyTypes are CPF, CNPJ, phone number or email. Example: +5511989898989. |
Request Body
{"accountCreated"=>"2022-02-01", "accountNumber"=>"5692908409716736", "accountType"=>"checking", "branchCode"=>"0000", "keyId"=>"+5511989898989", "name"=>"testKey", "taxId"=>"012.345.678-90"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"claim":{"accountCreated":"2022-02-02T02:59:59.999999+00:00","accountNumber":"5692908409716736","accountType":"checking","agent":"claimer","bankCode":"35547753","branchCode":"0000","claimedBankCode":"31804966","claimerBankCode":"35547753","created":"2022-05-17T19:31:21.972149+00:00","id":"5961418104897536","keyId":"postmanteste@starkbank.com","keyType":"email","name":"testKey","status":"created","taxId":"012.345.678-90","type":"ownership","updated":"2022-05-17T19:31:21.972154+00:00"},"message":"Key claim successfully requested."}