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=CNH" \
  -F "documentFront=@/path/to/cnh_frente.jpg" \
  -F "documentBack=@/path/to/cnh_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=CNH" \
  -F "documentFront=@/path/to/cnh_frente.jpg" \
  -F "documentBack=@/path/to/cnh_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
AuthorizationstringBasic Auth (API Key + Secret em Base64)
Content-Typestringmultipart/form-data

Path Parameters

ParâmetroTipoObrigatórioDescrição
userIdstringID da proposta

Form Data

CampoTipoObrigatórioDescrição
documentTypestringTipo: RG, CNH, CNH_DIGITAL, RNE
documentFrontfile⚠️Frente do documento (JPG/PNG)
documentBackfile⚠️Verso do documento (JPG/PNG)
documentPdffile⚠️PDF da CNH Digital (apenas CNH_DIGITAL)
selfiefileFoto do rosto (selfie)
Importante: Obrigatório enviar os seguintes campos:
RG, CNH, RNE: documentFront + documentBack + selfie
CNH_DIGITAL: documentPdf + 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

TipoFrenteVersoFormatoDescrição
RG✅ imagem✅ imagemJPG/PNGCédula de Identidade
CNH✅ imagem✅ imagemJPG/PNGCarteira Nacional (física)
RNE✅ imagem✅ imagemJPG/PNGRegistro Nacional Estrangeiro
CNH_DIGITALPDFCNH Digital (usa documentPdf)

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."
}