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."
}
Envia documentos manualmente para verificação KYC (alternativa ao widget).
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"
onboardingType for manual ou quando precisar reenviar documentos após reprovação.
onboardingType: "manual". Propostas do tipo liveness devem usar o widget KYC.baas:onboarding é configurado pela Owem na sua API Key.Authorization: Basic {Base64(API_KEY:API_SECRET)}
| Header | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | string | ✅ | Basic Auth (API Key + Secret em Base64) |
| Content-Type | string | ✅ | multipart/form-data |
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| userId | string | ✅ | ID da proposta |
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| documentType | string | ✅ | Tipo: RG, CNH, CNH_DIGITAL, RNE |
| documentFront | file | ⚠️ | Frente do documento (JPG/PNG) |
| documentBack | file | ⚠️ | Verso do documento (JPG/PNG) |
| documentPdf | file | ⚠️ | PDF da CNH Digital (apenas CNH_DIGITAL) |
| selfie | file | ✅ | Foto do rosto (selfie) |
documentFront + documentBack + selfie documentPdf + selfie {
"userId": "usr_abc123def456",
"status": "PROCESSING",
"executionId": "exec_789xyz",
"documentsReceived": {
"documentFront": true,
"documentBack": true,
"selfie": true
},
"message": "Documentos enviados. Aguarde processamento via webhook."
}
| Campo | Tipo | Descrição |
|---|---|---|
| userId | string | ID da proposta |
| status | string | Novo status: PROCESSING |
| executionId | string | ID da execução no sistema |
| documentsReceived | object | Arquivos recebidos |
| message | string | Mensagem de confirmação |
| Código | Descrição |
|---|---|
| 400 | Onboarding é tipo ‘liveness’, use o widget |
| 400 | Documentos já enviados ou KYC já processado |
| 400 | Tipo de documento inválido |
| 400 | CNH Digital requer envio do PDF no campo ‘documentPdf’ |
| 400 | RG/CNH/RNE requerem documentFront e documentBack |
| 400 | selfie é obrigatória |
| 403 | Proposta não pertence a este parceiro |
| 404 | Proposta não encontrada |
| Tipo | Frente | Verso | Formato | Descrição |
|---|---|---|---|---|
| RG | ✅ imagem | ✅ imagem | JPG/PNG | Cédula de Identidade |
| CNH | ✅ imagem | ✅ imagem | JPG/PNG | Carteira Nacional (física) |
| RNE | ✅ imagem | ✅ imagem | JPG/PNG | Registro Nacional Estrangeiro |
| CNH_DIGITAL | ❌ | ❌ | CNH Digital (usa documentPdf) |
| Requisito | Valor |
|---|---|
| Formatos imagem | JPG, JPEG, PNG, WebP |
| Formato PDF | PDF (apenas CNH_DIGITAL) |
| Tamanho máximo | 10MB por arquivo |
| Máximo arquivos | 3 arquivos por requisição |
| Qualidade | Foto nítida, sem reflexos |
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."
}
Was this page helpful?