Skip to main content
POST
Onboarding PJ (API)
POST /v2/submerchants/onboarding/pj Inicia o onboarding de uma subconta PJ. 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 jurídica. 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 do representante, a selfie, e os documentos da empresa: Regras:
  • Envie documentoFrente e documentoVerso, ou cnhCompleta.
  • O campo da selfie é selfie (não use mais selfieComDocumento).
Envie documentoFrente e documentoVerso do representante, ou envie cnhCompleta. Envie também selfie, contratoSocial e cartaoCnpj. 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
cnpj
string
required

CNPJ da empresa (14 dígitos)

Example:

"12345678000199"

representativeCpf
string
required

CPF do representante (11 dígitos)

Example:

"12345678901"

representativeName
string
required

Nome completo do representante

Maximum string length: 255
Example:

"Maria Souza"

birthDate
string<date>
required

Data de nascimento do representante (YYYY-MM-DD)

Example:

"1985-05-20"

phone
string
required

Telefone no formato E.164

Example:

"+5511888888888"

bankAccount
object
required

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

documentoFrente
file
required

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

documentoVerso
file
required

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

selfie
file
required

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

contratoSocial
file
required

Contrato social (PDF ou imagem)

cartaoCnpj
file
required

Cartão CNPJ (PDF ou imagem)

email
string<email>

Email de contato (opcional)

Maximum string length: 255
Example:

"contato@empresa.com"

cnhCompleta
file

CNH completa do representante. 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"