Start PIX key claim donor confirmation
POST /order/v1/banking/accounts/{accountId}/keys/claims/{claimId}/confirm-request
POST
/order/v1/banking/accounts/{accountId}/keys/claims/{claimId}/confirm-request
Used when this account currently holds a key being requested by another institution (donor side). Sends a confirmation code to the e-mail or phone registered on this account, proving the account holder is the one confirming or canceling the claim. Call POST :accountId/keys/claims/:claimId/confirm next with the returned validationId and the code.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” accountId
required
string format: uuid
Identifier of the account
claimId
required
string
Identifier of the claim, as returned by GET :accountId/keys/claims
Header Parameters
Section titled “Header Parameters ” idempotency-key
required
string format: uuid
A unique identifier for the message with a maximum of 64 characters (we recommend a UUID).
Responses
Section titled “ Responses ”Confirmation code dispatched to the account contact.
object
validationId
required
Identifier of the validation. Must be sent back on the confirm endpoint.
string
Example
a8f2b9c4-1e6a-4c3f-9d7b-2a1e8f9c5d10 status
required
Status of the validation
string
Example
PENDING expiresAt
required
Expiration date of the confirmation code
string
Example
2025-12-18T10:15:30Zobject
error
string
Example
INVALID_REQUEST message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[ { "field": "field_name", "issue": "INVALID", "description": "Field is invalid" }]Unauthorized Request
object
error
string
Example
UNAUTHORIZED message
string
Example
Unauthorized Request details
Array<object>
object
field
string
issue
string
description
string
Example
[]object
error
string
Example
INTERNAL_ERROR message
string
details
Array<object>
object
field
string
issue
string
description
string
Example
[]