Portability Inquiry by Account

Request

ENDPOINT

/baas/pix/key_claim_request/account/ACCOUNT_KEY

METHOD

GET

Request Body

Path Params

Field	Type	Description	Characters
account_key	string	identification key of the QIAccount.	36

Query Params

Field	Type	Description	Characters
page_number	integer	Current page being queried.	-
page_size	integer	Number of results per page.	-
claim_status	string	Portability status. If not provided, all unfinished portabilities will be listed.	Enumerators

Enumerators pix_key_type

Enumerator	Translation
pending	pending
opened	open
pending_confirmation	pending confirmation
confirmed	confirmed
cancelled	canceled
concluded	concluded
failed	failed
pending_donator_validation	pending donator validation
pending_claimer_validation	pending claimer validation

Response

STATUS

200

Response Body

{
  "data": [
    {
        "account_key": "be0884bc-44a4-4907-8627-ef976e477aef",
        "cancellation_reason": null,
        "cancelled_by": null,
        "claim_flow_type": "donator",
        "claim_request_key": "be0884bc-44a4-4907-8627-ef976e477aef",
        "claim_status": "pending_confirmation",
        "claim_type": "portability",
        "claimant_account_branch": "9999",
        "claimant_account_number": "0",
        "claimant_document_number": "37059093800",
        "claimant_person_type": "natural",
        "confirmation_reason": null,
        "created_at": "2023-11-06T17:30:11",
        "donator_ispb": 32402502,
        "limit_conclusion_date": null,
        "limit_resolve_date": "2023-11-13T17:29:00",
        "max_conclusion_date": null,
        "max_resolution_date": "2023-11-13T17:29:00",
        "pix_key": "45574823098",
        "pix_key_claim_id": "205c72ab-c03e-43b7-a43d-2409e21fa5be",
        "pix_key_type": "cpf",
        "requester_key": "be0884bc-44a4-4907-8627-ef976e477aef"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "rows_per_page": 10
  }
} 

STATUS

4XX

Response Body: Error

{
  "title": "title",
  "description": "description in English",
  "translation": "description in Portuguese",
  "code": "code",
  "extra_fields": {}
}

HTTP Code	QI Code code	Title title	Description Description	Translation translation
400	PIX000071	Unknown Claim Request Status	Unknown claim_status {claim_status}.	claim_status {claim_status} não reconhecido.
403	PIX000054	Invalid Permission	Person {person_key} does not have administration roles for account {account_key}.	Pessoa {person_key} não tem credencial de administrador para a conta {account_key}.