Submerchants
Adicionar documento
Adiciona um documento ao submerchant.
Adiciona um documento ao submerchant.
basicAuth In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
curl -X POST "https://example.com/v1/submerchants/string/documents" \ -H "Content-Type: application/json" \ -d '{ "type": "string", "file_url": "string", "file_name": "string", "file_size": 1, "mime_type": "string" }'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.
Número do documento (ex: número do RG)
URL do arquivo já hospedado
Nome do arquivo com extensão
Tamanho do arquivo em bytes
Tipo MIME (application/pdf, image/png, image/jpeg)
Data de validade do documento (ISO 8601)
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.
application/json
application/json
Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.
ID do submerchant
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.
{
"success": true,
"message": "string",
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"submerchant_id": "0534fe1e-3158-45a7-83b1-35fcc9d94bc5",
"legal_representative_id": "38620149-b0eb-42c2-bc3a-ce7cf6e4a7d6",
"type": "string",
"notes": "string",
"number": "string",
"file_url": "string",
"file_name": "string",
"file_size": 0,
"mime_type": "string",
"status": "pending",
"verified_at": "2019-08-24T14:15:22Z",
"verification_notes": "string",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}{
"success": false,
"message": "string",
"error": "string"
}{
"success": false,
"message": "string",
"error": "string"
}