Skip to main content
POST
Confirm a Pix key claim

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

REQUIRED. Client-supplied replay key, at most 64 bytes. A request without it is refused with PIX-0030 @ 400 before the handler runs. Replaying the same key with a divergent method, URL or body is PIX-0031 @ 412.

Required string length: 1 - 64
X-Account-Id
string
Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

X-Reason
enum<string>
required

Reason for the confirmation. The enum lists the canonical uppercase spelling; the server also accepts other casing and normalizes it, but clients SHOULD send the canonical form.

Available options:
USER_REQUESTED,
ACCOUNT_CLOSURE,
FRAUD,
DEFAULT_OPERATION,
RECONCILIATION,
RFB_VALIDATION
Maximum string length: 64
Example:

"USER_REQUESTED"

Path Parameters

claim_id
string
required
Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

Response

OK

accountId
string
required
Example:

"019606a1-3b4c-7d8e-9f01-234567890abc"

bacenId
string
required
Example:

"claim-bacen-001"

claimId
string
required
Example:

"019606c3-5d6e-7f80-1b23-456789012cde"

claimer
object
required
createdAt
string
required
Example:

"2026-05-19T14:30:00Z"

donorParticipant
string
required
Example:

"12345678"

keyType
string
required
Example:

"PHONE"

keyValue
string
required
Example:

"+5511987659999"

lastModified
string
required
Example:

"2026-05-19T14:32:11Z"

status
string
required
Example:

"WAITING_RESOLUTION"

type
string
required
Example:

"PORTABILITY"

updatedAt
string
required
Example:

"2026-05-19T14:32:11Z"

cancelReason
string
cancelledBy
string
completionPeriodEnd
string
Example:

"2026-06-18T03:00:00Z"

confirmReason
string
correlationId
string
Example:

"a9f13566e19f5ca51329479a5bae60c5"

requestId
string
Example:

"e7c1a2b3-4d5e-6f70-8a90-1b2c3d4e5f60"

resolutionPeriodEnd
string
Example:

"2026-05-25T03:00:00Z"