Skip to main content
POST
Register a PIX key entry

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
accountId
string
required

The CRM account id of the key owner.

Example:

"acc-123"

keyType
integer<int64>
required

Numeric eKeyType (0=CPF,1=CNPJ,2=EMAIL,3=PHONE,4=RANDOM).

Example:

2

isValidated
boolean

Ignored: the service always forces validation to start fresh.

Example:

false

key
string

The PIX key value (omit for a RANDOM key).

Example:

"foo@bar.com"

Response

Created

key
string

The PIX key value.

Example:

"11122233300"

keyType
integer<int64>

Numeric eKeyType.

Example:

4

status
integer<int64>

Numeric eKeyStatus.

Example:

1

statusDescription
string

Human-readable eKeyStatus label.

Example:

"ACTIVE"