Skip to main content
POST
Confirm PIX key ownership

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

entryId
string
obrigatório

The PIX key value (URL-encoded).

Exemplo:

"foo@bar.com"

Corpo

application/json
accountId
string
obrigatório

The CRM account id of the key owner.

Exemplo:

"acc-123"

token
string
obrigatório

The OTP ownership-confirmation code.

Exemplo:

"123456"

Resposta

OK

key
string

The PIX key value.

Exemplo:

"11122233300"

keyType
integer<int64>

Numeric eKeyType.

Exemplo:

4

status
integer<int64>

Numeric eKeyStatus.

Exemplo:

1

statusDescription
string

Human-readable eKeyStatus label.

Exemplo:

"ACTIVE"