Skip to main content
POST
Cadastrar beneficiário PIX
Beneficiário é destino de dinheiro: confirme o titular antes de cadastrar. Mudanças de beneficiário passam pelo fluxo de verificação da Korbit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

idempotency-key
string
required
Required string length: 1 - 255
x-korbit-dashboard-step-up
string
Pattern: ^[A-Za-z0-9_-]{43}$

Body

application/json
pixKey
string
required

A chave PIX em si — validada no cadastro (403/422 INVALID_PIX_KEY quando inválida).

Required string length: 1 - 320
pixKeyType
enum<string>
required

Tipo da chave informada: CPF, CNPJ, EMAIL, PHONE ou EVP (chave aleatória).

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
RANDOM

Response

Default Response

createdAt
string<date-time>
required
eligibilityCode
enum<string>
required
Available options:
ELIGIBLE,
PIX_KEY_TYPE_UNSUPPORTED,
PIX_KEY_TAX_ID_MISMATCH,
MERCHANT_IDENTITY_REQUIRED
id
string<uuid>
required
isPrimary
boolean
required
maskedPixKey
string
required
Required string length: 1 - 80
ownershipStatus
enum<string>
required
Available options:
PENDING,
VERIFIED,
REJECTED
pixKeyType
enum<string>
required
Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
RANDOM
updatedAt
string<date-time>
required
verificationMethod
enum<string> | null
required
Available options:
TAX_ID_MATCH