Skip to main content
POST
/
sub-accounts
/
document
/
company
Upload Documento Empresa
curl --request POST \
  --url https://gateway.3xpay.co/sub-accounts/document/company \
  --header 'Content-Type: multipart/form-data' \
  --header 'api_key: <api-key>' \
  --header 'api_secret: <api-key>' \
  --form documentType=PROOF_OF_RESIDENCE \
  --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 Empresa

Faz upload de documentos da empresa (Contrato Social).

​
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 (PROOF_OF_RESIDENCE, CNPJ, SOCIAL_CONTRACT)
​
file
File
required
Arquivo JPG, JPEG, PNG, GIF, WEBP ou PDF (máximo 10MB)

​
Tipos de Documento Empresarial Aceitos

Comprovante de Endereço
CNPJ da empresa
Contrato Social da empresa

​
Resposta de Sucesso (201)

{
  "status": "success",
  "message": "Documento da empresa enviado com sucesso.",
  "data": {
    "filename": "contrato-social.pdf",
    "document_type": "SOCIAL_CONTRACT",
    "document_format": "PDF"
  }
}

​
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:
PROOF_OF_RESIDENCE,
CNPJ,
SOCIAL_CONTRACT
​
file
file
required

Arquivo do documento

Response

201 - application/json

Documento da empresa enviado com sucesso

​
status
string

Status da resposta

Example:

"success"

​
message
string

Mensagem de resposta

Example:

"Documento enviado com sucesso."

​
data
object