Consult Portability Requests

Request

ENDPOINT

/account/ACCOUNT_KEY/alias/ALIAS_KEY/claim_request/CLAIM_REQUEST_KEY

METHOD

GET

Response

STATUS

200

Response Body

{
  {
    "request_control_key": "be0884bc-44a4-4907-8627-ef976e477aef",
    "claim_request_status": "pending",
    "claim_request_direction": "incoming",
    "claim_request_key": "fe3ab7c5-e907-4a66-b9c5-7ea156429f83",
    "pix_key": "12345678000190",
    "claim_request_type": "ownership",
    "pix_key_type": "cnpj",
    "cancellation_reason": null,
    "cancelled_by": "donor",
    "confirmation_reason": null,
    "created_at": "2024-05-25T12:13:25",
    "max_resolution_date": "2023-11-13T17:29:00",
    "claim_request_events": [
      {
       "event_type": "waiting_resolution",
       "event_details": "Relato de Infração recebido e em análise",
       "created_at": "2023-03-03T12:04:06.179Z"
      },
     {
       "event_type": "cancelled",
       "event_details": "Relato de Infração cancelado",
       "created_at": "2023-03-03T12:04:06.179Z"
     },
    ],
  }
} 

Value	Description	type
cancellation_reason	Reason for cancellation. "client_request", "account_closure", "fraud", "default", "reconciliation"	string
cancelled_by	Agent who canceled the portability request. "donor", "claimer"	string
claim_request_direction	Indicates whether the portability request was received or sent. "incoming" or "outgoing"	string
claim_request_key	Unique identification key of the claim.	string
claim_request_status	Status of the portability request.	string
claim_request_type	Type of portability request. "ownership" or "portability"	string
confirmation_reason	Reason for confirmation. "client_request", "account_closure", "fraud", "default", "reconciliation"	string
created_at	Date of creation of the portability request.	datetime string
max_conclusion_date	Deadline to close the portability request. Only for "ownership" type portabilities.	string
max_resolution_date	Deadline for the resolution of the portability request.	string
pix_key	PIX key of the portability request.	string
pix_key_type	Type of PIX key of the portability request.	string
request_control_key	Unique UUID4 identifier of the request.	uuid4 string
claim_request_events	Group of events related to the portability request.	uuid4 string

claim_request_status

Value	Description
waiting_resolution	The notification was received by the counterparty.
confirmed	The donor confirmed the claim. It is waiting for the claimer to complete the process.
cancelled	The donor or claimer canceled the portability request.
completed	Both the DICT and the claimer updated their records with the new linkage.