Skip to main content
POST
cURL with fictitious data

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

Idempotency-Key
string
required

Client-generated key used to retry exactly the same request safely.

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

UUID of the account associated with the operation.

Example:

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

X-Reason
string
required

Reason for the operation. Use USER_REQUESTED for a customer request.

Example:

"USER_REQUESTED"

Body

application/json
keyType
string
required

Pix key type

Example:

"CPF"

keyValue
string

Pix key value

Example:

"52998224725"

metadata
object

Free-form, single-level key/value pairs persisted with the entry. Keys up to 100 characters, values up to 2000 characters, at most 25 entries; nested objects are rejected.

Example:

Response

Created

account
object
required
createdAt
string<date-time>
required
Example:

"2019-11-18T03:00:00Z"

holderId
string
required
Example:

"019606e5-7f80-9102-3d45-678901234ef0"

id
string
required
Example:

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

keyCreationDate
string<date-time>
required
Example:

"2019-11-18T03:00:00Z"

keyOwnershipDate
string<date-time>
required
Example:

"2019-11-18T03:00:00Z"

keyType
string
required
Example:

"CPF"

keyValue
string
required
Example:

"52998224725"

organizationId
string
required
Example:

"019606d4-6e7f-8091-2c34-567890123def"

owner
object
required
requestId
string
required
Example:

"a946d533-7f22-42a5-9a9b-e87cd55c0f4d"

status
string
required
Example:

"ACTIVE"

updatedAt
string<date-time>
required
Example:

"2019-11-18T03:00:00Z"

metadata
object