Envio de Documentos
Upload e consulta de documentos do tomador e da empresa via API.
Enviando um documento
POST /credit-operations/{externalContractId}/documents
| Parâmetro | Tipo | Descrição |
|---|---|---|
externalContractId | string (path) | Identificador do contrato no sistema do parceiro — a operação de crédito deve já existir antes do upload. |
Upload via multipart/form-data. Formatos aceitos: JPEG, PNG, WEBP e PDF, com tamanho máximo de 10 MB por arquivo.
Tipos de documento (DocumentType)
DocumentType)| Valor | Uso |
|---|---|
IDENTITY_FRONT | Frente do documento de identidade do tomador. |
IDENTITY_BACK | Verso do documento de identidade do tomador. |
PROOF_OF_INCOME | Comprovante de renda. |
PROOF_OF_ADDRESS | Comprovante de endereço. |
SELFIE | Selfie para verificação biométrica. |
CCB | Cédula de Crédito Bancário gerada pela operação. (Caso a geração seja feita por outro sistema) |
OTHER | Documento sem categoria específica. |
CERTIFICATE_OF_INCORPORATION | Contrato social / certificado de constituição da empresa. |
MICRO_BUSINESSES_CERTIFICATE | Certificado de microempresa. |
INDIVIDUAL_ENTREPRENEUR_CERTIFICATE | Certificado de empreendedor individual (MEI). |
SHAREHOLDER_DRIVER_LICENCE_FRONT | Frente da CNH de um sócio. |
SHAREHOLDER_DRIVER_LICENCE_VERSE | Verso da CNH de um sócio. |
SHAREHOLDER_DIGITAL_DRIVER_LICENCE | CNH digital de um sócio. |
SHAREHOLDER_IDENTITY_CARD_FRONT | Frente do RG de um sócio. |
SHAREHOLDER_IDENTITY_CARD_VERSE | Verso do RG de um sócio. |
LEGAL_STATEMENT | Declaração jurídica. |
EIRELI_INCORPORATION_STATEMENT | Ato constitutivo de EIRELI. |
SHAREHOLDER_SELFIE | Selfie de um sócio. |
WORK_CARD | Carteira de trabalho. |
PROFESSIONAL_IDENTIFICATION_CARD | Carteira de identificação profissional (ex: OAB, CRM). |
MILITARY_IDENTIFICATION_CARD | Carteira de identificação militar. |
REVENUES_RECEIPT | Recibo de faturamento/receitas. |
PUBLIC_LETTER_OF_ATTORNEY | Procuração pública. |
PRIVATE_LETTER_OF_ATTORNEY | Procuração particular. |
EXTRAORDINARY_DOCUMENTS | Documentos extraordinários, fora das categorias padrão. |
Consultando um documento
GET /documents/{documentId}
Retorna o BorrowerDocument completo, incluindo o status atual.
Vinculando documentos a uma operação ou conta escrow
- Operação de crédito: o upload de documentos requer uma operação já criada — o
externalContractIddo path corresponde a uma operação existente. Crie a operação (POST /credit-operations) primeiro e faça os uploads em seguida. Os documentos ficam registrados emdocumentIdsda operação.
Updated 19 days ago
Did this page help you?
