Skip to main content

​
POST /sub-accounts/document

Faz upload de documentos pessoais da subconta (CPF, RG, etc.).

​
Headers

​
api_key
string
required
Chave de API da subconta
​
api_secret
string
required
Secret de API da subconta
​
Content-Type
string
required
multipart/form-data

​
Body (Form Data)

​
documentType
string
required
Tipo do documento (RG_FRONT, RG_BACK, CNH_FRONT, CNH_BACK, SELFIE)
​
file
File
required
Arquivo JPG, PNG ou PDF (máximo 10MB)

​
Exemplo de Requisição

# Upload RG Frente
curl -X POST http://localhost:3000/sub-accounts/document \
  -H "api_key: ak_1234567890abcdef" \
  -H "api_secret: as_1234567890abcdef" \
  -F "documentType=RG_FRONT" \
  -F "file=@rg_frente.jpg"

# Upload Selfie
curl -X POST http://localhost:3000/sub-accounts/document \
  -H "api_key: ak_1234567890abcdef" \
  -H "api_secret: as_1234567890abcdef" \
  -F "documentType=SELFIE" \
  -F "file=@selfie_socio.jpg"

​
Resposta de Sucesso (201)

{
  "status": "success",
  "message": "Documento enviado com sucesso.",
  "data": {
    "filename": "rg_frente.jpg",
    "document_type": "RG_FRONT",
    "document_format": "JPG"
  }
}

​
Validações

  • ✅ Tamanho máximo: 10MB
  • ✅ Tipo obrigatório: Deve especificar o tipo do documento
  • ✅ Arquivo obrigatório: Deve enviar um arquivo
  • ✅ Autenticação: Usa credenciais da própria subconta

​
Tipos de Documento Aceitos

RG Frente - Documento de identidade (lado da foto)
RG Verso - Documento de identidade (lado dos dados)
CNH Frente - Carteira de habilitação (lado da foto)
CNH Verso - Carteira de habilitação (lado dos dados)
Selfie do sócio para verificação facial

​
Possíveis Erros

{
  "message": "Tipo de documento inválido.",
  "statusCode": 400
}

{
  "message": "Api Key não encontrada.",
  "statusCode": 401
}

{
  "message": "Arquivo muito grande. Máximo 10MB.",
  "statusCode": 413
}
⌘I