Etapa 02 - Envio de Documentos

Envie documentos para o onboarding. Essa etapa requer o onboarding no status WAITING_REQUIRED_DOCUMENTS.

Enviar documentos

POST /v1/marketplaces/{marketplace_id}/onboarding/{onboarding_id}/documents

Exemplos

curl -X POST https://<base-url>/v1/marketplaces/{marketplaceId}/onboarding/{onboardingId}/documents \
  -H "Authorization: Basic $TOKEN" \
  -F "type=SELFIE" \
  -F "[email protected]"

const form = new FormData();
form.append("type", "SELFIE");
form.append("file", fs.createReadStream("./selfie.jpg"));
await fetch(`${base}/v1/marketplaces/${marketplaceId}/onboarding/${onboardingId}/documents`, {
  method: "POST",
  headers: { Authorization: "Basic " + token },
  body: form,
});

Resposta

201 Created com o documento criado

{ "document_id": "UUID" }

Tipos aceitos

type	Documento	Quem usa
SELFIE	Selfie do titular/sócio	PF e PJ
CNH_FRONT	CNH frente	PF e PJ
CNH_BACK	CNH verso	PF e PJ
RG_FRONT	RG frente	PF e PJ
RG_BACK	RG verso	PF e PJ
PAGINA_CONTRATO_SOCIAL	Contrato social	PJ
CCMEI	Certificado MEI	PJ (MEI)
PAGINA_ESTATUTO_SOCIAL	Estatuto social	PJ (SA)

Atenção
CIN, Passaporte e CREF não são aceitos no primeiro momento. Apenas CNH (física ou digital) ou RG (frente+verso) + Selfie.

Formatos e limites

Formatos: jpg, png, pdf
Tamanho máximo: 5 MB por arquivo

Consultar o que já foi enviado

GET /v1/marketplaces/{marketplace_id}/onboarding/{onboarding_id}

{
  "onboarding_id": "UUID",
  "status": "WAITING_REQUIRED_DOCUMENTS",
  "profile_id": "UUID",
  "documents": {
    "uploaded": [ { "type": "SELFIE" } ],
    "pending": [ "CNH_FRONT", "CNH_BACK" ]
  }
}

A resposta traz:

documents.uploaded[] — documentos já enviados (id + type)
documents.pending[] — tipos obrigatórios ainda não enviados

Regras Importantes

Envie os documentos um a um (uma chamada por documento)
Só é possível enviar enquanto o onboarding estiver no status WAITING_REQUIRED_DOCUMENTS ou WAITING_APPROVAL_REQUEST
Em caso de erro no envio (imagem tremida, formato inválido), o processo é negado com indicação do motivo (retorno via webhook onboarding.rejected), por isso se atente às regras e boas práticas abaixo:

📸
Recomendações para o envio de documentos:

Escolha ambiente iluminado

Enquadre bem os documentos

Não use flash do celular ao fotografar, ele pode ofuscar algum dado e atrapalhar nossa equipe na análise das informações

Antes de enviar as fotos, confira se tudo está fácil de ler. Se você consegue identificar os dados, nossa equipe também será capaz

🤳
Recomendações para o envio de selfie:
Providencie iluminação suficiente

Escolha o caminho do meio: nem muita nem pouca luz

Faça teste com luminárias de mesa, que não precisam ser direcionadas diretamente para seu rosto

Experimente apontar para a parede, por exemplo, de maneira que reflita sua face, mas sem deixá-la clara demais

Preste atenção às janelas, evitando luz forte

Use o flash somente se não tiver outras alternativas

O brilho provocado pelo flash e o efeito "olhos vermelhos" podem dificultar o reconhecimento

Só use flash se não puder recorrer a outros meios para produzir a iluminação adequada

Mantenha os olhos abertos
Aposte na pose frontal

Esteticamente, dar uma leve inclinada na cabeça e um "olhar 43" tendem a tornar o rosto mais agradável

Mas, para a identificação, o melhor é fazer a foto de frente, de maneira que os algoritmos reconheçam a imagem do rosto mais rapidamente

Evite usar óculos e outros acessórios como chapéus e bonés

📘
Exemplos de uso:
Caso 1: Cadastro de pessoa física com CNH_FULL
Chamada 1 ao endpoint de envio de documentos: envio do document_type = SELFIE

A selfie é armazenada na camada Zoop

Chamada 2 ao endpoint de envio de documentos: envio do document_type = CNH_FULL

A CNH é armazenada na camada Zoop

Caso 2: Cadastro de pessoa física sobrescrevendo o RG_BACK
Chamada 1 ao endpoint de envio de documentos: envio do document_type = SELFIE

A selfie é armazenada na camada Zoop

Chamada 2 ao endpoint de envio de documentos: envio do document_type = RG_FRONT

A frente do RG é armazenada na camada Zoop

Chamada 3 ao endpoint de envio de documentos: envio do document_type = RG_BACK

A parte de trás do RG é armazenada na camada Zoop

Chamada 4 ao endpoint de envio de documentos: envio do document_type = RG_BACK

Sobrescrita da parte de trás do RG, desconsiderando o enviado na chamada 3