Skip to main content
POST
/
sub-accounts
/
document
Upload Documento Pessoal
curl --request POST \
  --url https://gateway.3xpay.co/sub-accounts/document \
  --header 'Content-Type: multipart/form-data' \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>' \
  --form documentType=RG_FRONT \
  --form file=@example-file
{
  "status": "success",
  "message": "Documento enviado com sucesso.",
  "data": {
    "filename": "rg_frente.jpg",
    "document_type": "RG_FRONT",
    "document_format": "JPG"
  }
}

​
Upload de Documento Pessoal

Faz upload de documentos pessoais da subconta (RG, CNH, Selfie).

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

​
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

​
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

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

Authorizations

​
api_key
string
header
required
​
api_secret
string
header
required

Body

multipart/form-data
​
documentType
enum<string>
required

Tipo do documento

Available options:
RG_FRONT,
RG_BACK,
CNH_FRONT,
CNH_BACK,
SELFIE
​
file
file
required

Arquivo do documento

Response

201 - application/json

Documento enviado com sucesso

​
status
string

Status da resposta

Example:

"success"

​
message
string

Mensagem de resposta

Example:

"Documento enviado com sucesso."

​
data
object
⌘I