Skip to main content
POST
/
v4
/
i
/
baas
/
onboarding
/
{userId}
/
documents
/
upload
curl -X POST https://api.owem.com.br/v4/i/baas/onboarding/usr_abc123def456/documents/upload \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -F "documentType=RG" \
  -F "documentFront=@/path/to/rg_frente.jpg" \
  -F "documentBack=@/path/to/rg_verso.jpg" \
  -F "selfie=@/path/to/selfie.jpg"

{
  "userId": "usr_abc123def456",
  "status": "PROCESSING",
  "executionId": "exec_789xyz",
  "documentsReceived": {
    "documentFront": true,
    "documentBack": true,
    "selfie": true
  },
  "message": "Documentos enviados. Aguarde processamento via webhook."
}

curl -X POST https://api.owem.com.br/v4/i/baas/onboarding/usr_abc123def456/documents/upload \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -F "documentType=RG" \
  -F "documentFront=@/path/to/rg_frente.jpg" \
  -F "documentBack=@/path/to/rg_verso.jpg" \
  -F "selfie=@/path/to/selfie.jpg"

​
Descrição

Este endpoint permite o upload manual de documentos para verificação KYC, como alternativa ao widget. Use quando onboardingType for manual ou quando precisar reenviar documentos após reprovação.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.
Este endpoint só funciona para propostas criadas com onboardingType: "manual". Propostas do tipo liveness devem usar o widget KYC.

​
Autenticação

Este endpoint usa Basic Auth com sua API Key + Secret. O scope baas:onboarding é configurado pela Owem na sua API Key.
Authorization: Basic {Base64(API_KEY:API_SECRET)}

​
Request

​
Headers

HeaderTipoObrigatórioDescrição
Authorizationstring✅Basic Auth (API Key + Secret em Base64)
Content-Typestring✅multipart/form-data

​
Path Parameters

ParâmetroTipoObrigatórioDescrição
userIdstring✅ID da proposta

​
Form Data (multipart/form-data)

CampoTipoObrigatórioDescrição
documentTypestring✅Tipo: RG, RG_FULL, CNH, CNH_FULL, CNH_DIGITAL, PASSPORT, RNE
documentFrontfile⚠️Frente do documento (JPG/PNG)
documentBackfile⚠️Verso do documento (JPG/PNG)
documentPdffile⚠️PDF da CNH Digital (apenas CNH_DIGITAL)
selfiefile✅Foto do rosto (selfie)

​
Body JSON (Base64 - alternativa)

{
  "documentType": "RG",
  "documentFront": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
  "documentBack": "data:image/jpeg;base64,/9j/4AAQSkZJRg...",
  "selfie": "data:image/jpeg;base64,/9j/4AAQSkZJRg..."
}
CampoTipoObrigatórioDescrição
documentTypestring✅Tipo do documento
documentFrontstring⚠️Imagem em Base64 (com ou sem prefixo data:)
documentBackstring⚠️Imagem em Base64 (com ou sem prefixo data:)
documentPdfstring⚠️PDF em Base64 (apenas CNH_DIGITAL)
selfiestring✅Selfie em Base64
Dois formatos aceitos: Você pode enviar via multipart/form-data (arquivos binários) ou application/json (Base64). Escolha o que for mais conveniente para sua integração.
Campos obrigatórios por tipo de documento:
TipoCampos Obrigatórios
RG, CNH, RNEdocumentFront + documentBack + selfie
RG_FULL, CNH_FULL, PASSPORTdocumentFront + selfie (captura única)
CNH_DIGITALdocumentPdf + selfie

​
Response

​
Sucesso (200 OK)

{
  "userId": "usr_abc123def456",
  "status": "PROCESSING",
  "executionId": "exec_789xyz",
  "documentsReceived": {
    "documentFront": true,
    "documentBack": true,
    "selfie": true
  },
  "message": "Documentos enviados. Aguarde processamento via webhook."
}

​
Campos da Response

CampoTipoDescrição
userIdstringID da proposta
statusstringNovo status: PROCESSING
executionIdstringID da execução no sistema
documentsReceivedobjectArquivos recebidos
messagestringMensagem de confirmação

​
Erros

CódigoDescrição
400Onboarding é tipo ‘liveness’, use o widget
400Documentos já enviados ou KYC já processado
400Tipo de documento inválido
400CNH Digital requer envio do PDF no campo ‘documentPdf’
400RG/CNH/RNE requerem documentFront e documentBack
400selfie é obrigatória
403Proposta não pertence a este parceiro
404Proposta não encontrada

​
Documentos Aceitos

TipoFrenteVersoPDFDescrição
RG✅ imagem✅ imagem❌Cédula de Identidade (frente+verso)
RG_FULL✅ imagem❌❌🆕 RG aberto (captura única)
CNH✅ imagem✅ imagem❌Carteira Nacional (frente+verso)
CNH_FULL✅ imagem❌❌🆕 CNH aberta (captura única)
CNH_DIGITAL❌❌✅CNH Digital (usa documentPdf)
PASSPORT✅ imagem❌❌🆕 Passaporte (captura única)
RNE✅ imagem✅ imagem❌Registro Nacional Estrangeiro
Documentos de captura única: RG_FULL, CNH_FULL e PASSPORT são documentos que mostram todas as informações em uma única foto (documento aberto ou página principal). Nesses casos, envie apenas documentFront + selfie.

​
Requisitos dos Arquivos

RequisitoValor
Formatos imagemJPG, JPEG, PNG, WebP
Formato PDFPDF (apenas CNH_DIGITAL)
Tamanho máximo10MB por arquivo
Máximo arquivos3 arquivos por requisição
QualidadeFoto nítida, sem reflexos

​
Fluxo Após Upload

Após o upload, o status muda para PROCESSING. Você receberá um webhook quando a análise for concluída.
{
  "userId": "usr_abc123def456",
  "status": "PROCESSING",
  "executionId": "exec_789xyz",
  "documentsReceived": {
    "documentFront": true,
    "documentBack": true,
    "selfie": true
  },
  "message": "Documentos enviados. Aguarde processamento via webhook."
}