Skip to main content
POST
Adicionar documento

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Path Parameters

id
string
required

ID do submerchant

Body

application/json

Documentos obrigatórios variam por tipo de entidade. PJ: social_contract, contract_amendment (opcional), cnpj_card, proof_of_residence_company. PF: front_id, back_id, selfie_with_id, proof_of_residence. Sócios (PJ): partner_front_id, partner_back_id, partner_selfie_with_id, partner_proof_of_residence — obrigam legal_representative_id. Reenviar um documento do mesmo type (e mesmo legal_representative_id se for de sócio) marca o anterior como substituído. Formatos aceitos: PNG, JPG, JPEG, PDF.

type
string
required

Tipo do documento. Empresa (PJ): social_contract, contract_amendment, cnpj_card, proof_of_residence_company. Pessoa (PF): front_id, back_id, selfie_with_id, proof_of_residence. Sócio (PJ): partner_front_id, partner_back_id, partner_selfie_with_id, partner_proof_of_residence.

Required string length: 1 - 100
file_url
string
required

URL do arquivo já hospedado

Maximum string length: 500
file_name
string
required

Nome do arquivo com extensão

Maximum string length: 255
file_size
integer
required

Tamanho do arquivo em bytes

Required range: x >= 1
mime_type
string
required

Tipo MIME (application/pdf, image/png, image/jpeg)

Maximum string length: 100
number
string

Número do documento (ex: número do RG)

Maximum string length: 100
expires_at
string<date-time>

Data de validade do documento (ISO 8601)

notes
string

Anotações livres sobre o documento

Obrigatório quando type começa com partner_. Proibido nos demais tipos. Liga o documento a um sócio cadastrado em /legal-representatives.

Response

Documento criado

success
boolean
Example:

true

message
string
data
object