Skip to main content

Portability Request creation

Request

ENDPOINT
/account/ACCOUNT_KEY/alias/ALIAS_KEY/claim_request
METHOD
POST
Request Body
{
"request_control_key": "4b61f25d-b8b5-49cb-a391-e4878091ac3f",
"pix_key": "12345678000190",
"claim_request_type": "ownership",
"pix_key_type": "cnpj"
}
FieldTypeDescriptionMax. Characters
request_control_key *stringUUID4 for querying about the made request.36
pix_key *stringPIX key related to the portability request36
claim_request_type *stringType of portability. "ownership" for claim and "portability" for portability36
pix_key_type *stringDefinition of key type. Can be "cpf", "cnpj", "email", "phone_number".10

Response

STATUS
201 created
Response Body
{
"request_control_key": "8a923886-afce-4116-ac1f-69bdffcf8da9",
"claim_request_status": "pending",
"claim_request_key": "fe3ab7c5-e907-4a66-b9c5-7ea156429f83",
"max_conclusion_date": "2024-05-26T12:13:25",
"created_at": "2024-05-25T12:13:25"
}