Enviar Documentos

1. Informações Gerais

Utilize este endpoint para anexar os documentos comprobatórios necessários para a formalização da proposta de crédito.

Esta etapa é assíncrona: o endpoint recebe o arquivo, mas a validação do conteúdo (análise do documento) ocorre posteriormente pelo time interno da Creditas.

2. Pré-requisitos

Antes de iniciar o upload, certifique-se de que:

A proposta possui um proposalId válido.
O status da proposta é DOCUMENTS. Você pode verificar isso através do endpoint GET /proposals/{proposalId}/status.

3. Restrições Técnicas

O não cumprimento destas regras resultará em erro 400 Bad Request ou 413 Payload Too Large.

Característica	Regra
Formatos aceitos	JPEG, PNG, PDF, PPM, DOCX, TIF
Tamanho máximo	50 MB por arquivo
Formato de envio	multipart/form-data
Cardinalidade	1 arquivo por requisição (para múltiplos arquivos, faça múltiplas chamadas)

4. Tipos de Documentos Aceitos

Utilize os valores da coluna Enum no parâmetro type da sua requisição.

Enum (`type`)	Descrição	Regra de Negócio
`INCOME_STATEMENT`	Comprovante de Renda	Assalariado: holerite do último mês Aposentado: extrato do último benefício Autônomo: extrato bancário dos últimos 3 meses
`PROOF_RESIDENCE`	Comprovante de Residência	O documento deve conter dados pessoais, endereço, descrição de gastos e código de barras visível.
`PROOF_IDENTITY`	Documento de Identidade	RG ou CNH (Frente e Verso) *Deve estar fora do plástico e legível

📘
Nota de UX: Instrua seu usuário final a tirar fotos em locais iluminados, sem flash e garantindo que todas as bordas do documento estejam visíveis. Isso reduz a taxa de rejeição do documento enviado.

5. Referência Técnica Para o Envio de Documentos

5.1. Request HTTP

Tipo de Requisição	URL	Exemplo
`POST`	`{{url_base}}/proposals/:proposalId/documents`	https://stg-api.creditas.io/b2/proposals/:proposalId/documents

5.2. Request Headers

Header	Valor
`Accept`	application/vnd.creditas.v1+json
`Content-Type`	application/json;charset=UTF-8
`Authorization`	Bearer `{{AUTHENTICATION_TOKEN}}`

5.3. Form Data Parameters

Parâmetro	Tipo	Obrigatório	Descrição
`File`	Binary	Sim	O arquivo binário do documento a ser enviado.
`Type`	String	Sim	O tipo do documento (ex: P`ROOF_RESIDENCE`).

5.4. Exemplo de Request e Response

curl --location --request POST '{{url_base}}/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/documents' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: multipart/form-data' \
--header 'Authorization: Bearer {{your_access_token}}'
--form 'file=@"{{your_file}}"' \
--form 'group="PROOF_RESIDENCE"'

{
    "id": "Id do documento"
}

6. Consultar Documentos Enviados

Retorna a lista de todos os documentos já anexados à proposta. Útil para verificar se todos os itens obrigatórios (INCOME, IDENTITY, RESIDENCE) já foram enviados.

6.1. Request HTTP

Tipo de Requisição	URL	Exemplo
`GET`	`{{url_base}}/proposals/:proposalId/documents`	https://stg-api.creditas.io/b2/proposals/:proposalId/documents

6.2. Exemplo de Request e Response

curl --location --request GET '{{url_base}}/proposals/B2B-68A9769C-1DFB-47B5-BBC2-A25DB0C2D0D0/documents' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Authorization: Bearer {{your_access_token}}'

{
    "items": [
        {
            "id": "Id do Documento",
            "type": "INCOME_STATEMENT"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_IDENTITY"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_RESIDENCE"
        },
        {
            "id": "Id do Documento",
            "type": "INCOME_STATEMENT"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_IDENTITY"
        },
        {
            "id": "Id do Documento",
            "type": "PROOF_RESIDENCE"
        }
    ],
    "cursors": {}
}

7. Possíveis Erros

Código	Mensagem	Descrição
`409`	Step Document is not Started to proposal `{{proposalId}}`	O status da proposta não é de DOCUMENTS
`400`	Some fields are invalid. Must be one of nados ao realizar um envio de documen	Tipo de arquivo inválido