Skip to main content
POST
Register a PIX key entry

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Cuerpo

application/json
accountId
string
requerido

The CRM account id of the key owner.

Ejemplo:

"acc-123"

keyType
integer<int64>
requerido

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

Ejemplo:

2

isValidated
boolean

Ignored: the service always forces validation to start fresh.

Ejemplo:

false

key
string

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

Ejemplo:

"foo@bar.com"

Respuesta

Created

key
string

The PIX key value.

Ejemplo:

"11122233300"

keyType
integer<int64>

Numeric eKeyType.

Ejemplo:

4

status
integer<int64>

Numeric eKeyStatus.

Ejemplo:

1

statusDescription
string

Human-readable eKeyStatus label.

Ejemplo:

"ACTIVE"