Skip to main content
POST
Confirm PIX key ownership

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

entryId
string
requerido

The PIX key value (URL-encoded).

Ejemplo:

"foo@bar.com"

Cuerpo

application/json
accountId
string
requerido

The CRM account id of the key owner.

Ejemplo:

"acc-123"

token
string
requerido

The OTP ownership-confirmation code.

Ejemplo:

"123456"

Respuesta

OK

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"