Skip to main content
POST
Onboarding PF (API)
POST /v2/submerchants/onboarding/pf Inicia o onboarding de uma subconta PF. A requisição é multipart/form-data e retorna 202 Accepted com o registration_id e o status inicial.
Inicia o onboarding assíncrono de subconta pessoa física. Retorna 202 com registration_id. Exige headers client-id + client-secret e x-idempotency-key (UUID v4).

Arquivos (multipart)

Envie uma das opções de documento de identidade, mais a selfie: Regras:
  • Envie documentoFrente e documentoVerso, ou cnhCompleta.
  • O campo da selfie é selfie (não use mais selfieComDocumento).
Envie documentoFrente e documentoVerso, ou envie cnhCompleta. O campo da selfie é selfie. Não use selfieComDocumento. Depois do 202, consulte o status com o registration_id. Veja o guia Subcontas.

Authorizations

client-id
string
header
required
client-secret
string
header
required

Headers

client-secret
string
required

Secret da credencial do merchant

client-id
string
required

ID público da credencial do merchant

x-idempotency-key
string<uuid>
required

UUID v4 gerado pelo cliente. Usado como externalId da subconta.

Body

multipart/form-data
document
string
required

CPF do titular (11 dígitos)

Example:

"12345678901"

fullName
string
required

Nome completo do titular

Maximum string length: 255
Example:

"João da Silva"

birthDate
string<date>
required

Data de nascimento (YYYY-MM-DD)

Example:

"1990-01-15"

phone
string
required

Telefone no formato E.164

Example:

"+5511999999999"

addressZipCode
string
required

CEP

Maximum string length: 10
Example:

"01310100"

addressStreet
string
required

Logradouro

Maximum string length: 255
Example:

"Avenida Paulista"

addressNumber
string
required

Número do endereço

Maximum string length: 20
Example:

"1000"

addressNeighborhood
string
required

Bairro

Maximum string length: 100
Example:

"Bela Vista"

addressCity
string
required

Cidade

Maximum string length: 100
Example:

"São Paulo"

addressState
string
required

UF (2 caracteres)

Maximum string length: 2
Example:

"SP"

bankAccount
object
required

Dados bancários. Em multipart, envie como JSON string.

documentoFrente
file
required

Frente do RG/CIN. Obrigatório com documentoVerso, se não enviar cnhCompleta.

documentoVerso
file
required

Verso do RG/CIN. Obrigatório com documentoFrente, se não enviar cnhCompleta.

selfie
file
required

Selfie do titular (rosto). Não use selfieComDocumento.

email
string<email>

Email de contato (opcional)

Maximum string length: 255
Example:

"joao@exemplo.com"

addressComplement
string

Complemento do endereço

Maximum string length: 255
Example:

"Apto 101"

cnhCompleta
file

CNH completa. Alternativa a documentoFrente + documentoVerso.

Response

Onboarding iniciado

registration_id
string<uuid>
required

ID do registro de onboarding

Example:

"2f1c8b9a-4d3e-4f6a-9b1c-0a1b2c3d4e5f"

status
string
required

Status do onboarding após o submit ou reenvio

Example:

"submitted"