Pular para o conteúdo principal
PATCH
Atualizar remetente (parcial)

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

Idempotency-Key
string
obrigatório

Unique key to prevent duplicate creation or execution.

Required string length: 8 - 128

Parâmetros de caminho

senderId
string
obrigatório

Corpo

application/json

Atualização parcial. Documento com mesmo type+número é atualizado; número diferente retira o anterior e cria novo (trilha preservada).

firstName
string
Maximum string length: 150
middleName
string
Maximum string length: 150
lastName
string
Maximum string length: 150
businessName
string

Obrigatório quando type = BUSINESS.

Maximum string length: 200
email
string<email>
phoneNumber
string

E.164.

Exemplo:

"+15551234567"

birthDate
string<date>

Remetente INDIVIDUAL deve ter 18 anos ou mais.

nationality
string
Pattern: ^[A-Z]{2}$
address
object
documents
object[]
occupation
string
employerName
string
sourceOfFunds
enum<string>
Opções disponíveis:
SALARY,
SAVINGS,
BUSINESS_INCOME,
INVESTMENTS,
PENSION,
GIFT,
OTHER

Resposta

Remetente atualizado

senderId
string
obrigatório
externalId
string
obrigatório
type
enum<string>
obrigatório
Opções disponíveis:
INDIVIDUAL,
BUSINESS
status
enum<string>
obrigatório
Opções disponíveis:
ACTIVE,
RESTRICTED,
BLOCKED,
INACTIVE
complianceLevel
enum<string>
obrigatório

LEVEL_0 não transaciona. Requisitos e limites por nível são configurados por cliente.

Opções disponíveis:
LEVEL_0,
LEVEL_1,
LEVEL_2,
LEVEL_3
createdAt
string<date-time>
obrigatório
updatedAt
string<date-time>
obrigatório
firstName
string
middleName
string
lastName
string
businessName
string
email
string
phoneNumber
string
birthDate
string<date>
nationality
string
address
object
documents
object[]
occupation
string
employerName
string
sourceOfFunds
string
nextLevel
object | null

Próximo nível de compliance e dados que faltam para alcançá-lo. Nulo no nível máximo.