Skip to main content
POST
Start PF session

Autorizações

Authorization
string
header
obrigatório

Bearer API key (recommended). Format: Bearer sk_live_<hex>. Send the key directly - no signature, nonce or timestamp. Create/revoke keys in the dashboard or via /partners/me/api-keys. Accepted on the same routes as the HMAC scheme. - API key Bearer (recomendada), aceita nas mesmas rotas que o esquema HMAC.

Corpo

application/json
externalUserId
string
obrigatório
Required string length: 1 - 128
documentNumber
string
obrigatório
Required string length: 5 - 30
fullName
string
obrigatório
Required string length: 1 - 120
birthDate
string
obrigatório
Required string length: 8 - 30
motherName
string
obrigatório
Required string length: 1 - 120
email
string<email>
obrigatório
Maximum string length: 100
isPoliticallyExposedPerson
boolean
obrigatório
documentType
enum<string>
Opções disponíveis:
CPF,
CNPJ,
RG,
PASSPORT,
SSN,
DNI,
CURP,
RUT,
CC,
NIT,
OTHER
country
string
Required string length: 2
socialName
string
Maximum string length: 120
phoneNumber
string
Maximum string length: 20
address
object
taxResidence
object[]
Maximum array length: 10
selfCertification
boolean
monthlyIncomeCents
integer
Intervalo obrigatório: x >= 0
incomeSource
enum<string>
Opções disponíveis:
salary,
business_income,
investments,
inheritance,
savings,
crypto_trading,
freelance,
real_estate,
other

Resposta

Default Response