Criar um novo documento para a Empresa

Este endpoint permite enviar um novo documento que será associado ao cadastro de uma Empresa ou à jornada de contratação de crédito na Plataforma.

Durante a Solicitação de Crédito, o sistema valida se todos os documentos obrigatórios — definidos na configuração do Produto — foram previamente cadastrados.


Parâmetros de Path

NomeTipoObrigatórioDescrição
business_idstring (UUID v4)SimIdentificador do cadastro da Empresa à qual o documento será associado

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação no formato Bearer {token}
Content-TypestringSimDeve ser multipart/form-data

Body Parameters (multipart/form-data)

Dados do Documento

CampoTipoObrigatórioDescrição
filefileSimArquivo do documento a ser enviado
typestringSimTipo do documento (ver lista de tipos aceitos)
observationsstringNãoObservações ou comentários sobre o documento enviado

Tipos de Documentos Aceitos (type)

ValorDescrição
BALANCE_SHEETSBalanço Patrimonial
INCOME_STATEMENTComprovante de Renda
PROOF_OF_ADDRESSComprovante de Endereço
BYLAWSEstatuto Social
INCORPORATION_CERTIFICATERegistro de Incorporação
FEDERAL_REGISTER_CERTIFICATECartão CNPJ
INVOICEComprovante
CERTIFICATECertidão
LETTER_OF_ATTORNEYProcuração
CONTRACTContrato
OTHEROutro

Exemplo de Requisição

Form-data

KeyTipoValue
filefilecomprovante_endereco.pdf
typetextPROOF_OF_ADDRESS
observationstextDocumento atualizado emitido em janeiro de 2026

Resposta de Sucesso

Status: 201 Created

{
    "id": "03c1526b-4ea9-40e1-8514-2eb7685c0475",
    "type": "PROOF_OF_ADDRESS",
    "observations": "Documento atualizado emitido em janeiro de 2026",
    "status": "OK",
    "file_extension": "pdf",
    "file_name": "comprovante_endereco.pdf",
    "entity_id": "c47ea1c9-0f67-429f-a1b7-ace6f6bea704",
    "created_at": "2026-01-20T16:14:31.268878Z",
    "version": 0
}

Estrutura da Resposta

CampoTipoDescrição
idstring (UUID v4)Identificador do documento
typestringTipo do documento enviado
observationsstringObservações associadas ao documento
statusstringStatus do processamento do documento
file_extensionstringExtensão do arquivo
file_namestringNome do arquivo armazenado
created_atdatetimeData e hora de criação
versionintegerVersão do registro
Language
Credentials
OAuth2
Required Scopes
URL
Click Try It! to start a request and see the response here!