Skip to main content
GET
/
v4
/
i
/
baas
/
onboarding
/
all
curl -X GET "https://api.owem.com.br/v4/i/baas/onboarding/all?limit=50&offset=0" \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

{
  "requestId": "a867c780-fb94-44a9-a058-1af78c7d41c9",
  "success": true,
  "size": 2,
  "pagination": {
    "total": 2,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "userId": "usr_abc123def456",
      "clientCode": "baas_x7k2m9p1",
      "status": "ACCOUNT_CREATED",
      "cpf": "12345678900",
      "name": "João da Silva",
      "email": "[email protected]",
      "onboardingType": "liveness",
      "hasAccount": true,
      "createdAt": 1768245117000,
      "updatedAt": 1768252317000
    },
    {
      "userId": "usr_xyz789ghi012",
      "clientCode": "baas_y8l3n0q2",
      "status": "PENDING_EMAIL_VERIFICATION",
      "cpf": "98765432100",
      "name": "Maria Santos",
      "email": "[email protected]",
      "onboardingType": "manual",
      "hasAccount": false,
      "createdAt": 1768252800000,
      "updatedAt": 1768252800000
    }
  ]
}

curl -X GET "https://api.owem.com.br/v4/i/baas/onboarding/all?limit=50&offset=0" \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

​
Descrição

Lista todas as propostas de onboarding criadas pelo parceiro. Suporta paginação e filtro por status.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.

​
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)

​
Query Parameters

ParâmetroTipoObrigatórioDefaultDescrição
limitnumber❌50Máximo de resultados (1-100)
offsetnumber❌0Paginação (início dos resultados)
statusstring❌-Filtrar por status específico

​
Valores de Status para Filtro

StatusDescrição
PENDING_EMAIL_VERIFICATIONAguardando verificação de email
PENDING_DOCUMENTSAguardando verificação KYC
PROCESSINGEm análise pelo sistema
APPROVEDKYC aprovado
REPROVEDKYC reprovado
ACCOUNT_CREATEDConta bancária criada com sucesso

​
Response

​
Sucesso (200 OK)

{
  "requestId": "a867c780-fb94-44a9-a058-1af78c7d41c9",
  "success": true,
  "size": 2,
  "pagination": {
    "total": 2,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "userId": "usr_abc123def456",
      "clientCode": "baas_x7k2m9p1",
      "status": "ACCOUNT_CREATED",
      "cpf": "12345678900",
      "name": "João da Silva",
      "email": "[email protected]",
      "onboardingType": "liveness",
      "hasAccount": true,
      "createdAt": 1768245117000,
      "updatedAt": 1768252317000
    },
    {
      "userId": "usr_xyz789ghi012",
      "clientCode": "baas_y8l3n0q2",
      "status": "PENDING_EMAIL_VERIFICATION",
      "cpf": "98765432100",
      "name": "Maria Santos",
      "email": "[email protected]",
      "onboardingType": "manual",
      "hasAccount": false,
      "createdAt": 1768252800000,
      "updatedAt": 1768252800000
    }
  ]
}

​
Campos da Response

CampoTipoDescrição
userIdstringID único da proposta/usuário
clientCodestringCódigo interno (formato: baas_xxxxxxxx)
statusstringStatus atual da proposta
cpfstringCPF do cliente (sem formatação)
namestringNome completo do cliente
emailstringEmail do cliente
onboardingTypestringTipo: liveness ou manual
hasAccountbooleanSe já possui conta bancária criada
createdAtnumberTimestamp de criação (ms)
updatedAtnumberTimestamp da última atualização (ms)

​
Paginação

CampoTipoDescrição
totalnumberTotal de propostas do parceiro
limitnumberLimite usado na consulta
offsetnumberOffset usado na consulta

​
Erros

CódigoDescrição
400Parâmetros inválidos
403API Key não autorizada
Use este endpoint para monitorar o progresso de todas as suas propostas. Combine com webhooks para atualizações em tempo real.
{
  "requestId": "a867c780-fb94-44a9-a058-1af78c7d41c9",
  "success": true,
  "size": 2,
  "pagination": {
    "total": 2,
    "limit": 50,
    "offset": 0
  },
  "data": [
    {
      "userId": "usr_abc123def456",
      "clientCode": "baas_x7k2m9p1",
      "status": "ACCOUNT_CREATED",
      "cpf": "12345678900",
      "name": "João da Silva",
      "email": "[email protected]",
      "onboardingType": "liveness",
      "hasAccount": true,
      "createdAt": 1768245117000,
      "updatedAt": 1768252317000
    },
    {
      "userId": "usr_xyz789ghi012",
      "clientCode": "baas_y8l3n0q2",
      "status": "PENDING_EMAIL_VERIFICATION",
      "cpf": "98765432100",
      "name": "Maria Santos",
      "email": "[email protected]",
      "onboardingType": "manual",
      "hasAccount": false,
      "createdAt": 1768252800000,
      "updatedAt": 1768252800000
    }
  ]
}