Listar Documentos

Como listar todos os documentos enviados para uma Proposta (proposalId).

Utilize este endpoint para consultar todos os documentos já enviados para uma proposta de crédito.

É recomendado utilizar esta listagem para verificar quais documentos já foram enviados antes de realizar novos uploads, evitando duplicidades. Para detalhes sobre como enviar documentos, consulte a página Enviar Documentos.

Pré-requisitos

Antes de consultar os documentos, certifique-se de que:

A proposta possui um proposalId válido. Consulte a página Criar Proposta para detalhes sobre como criar uma proposta e obter o proposalId.

Endpoint

Tipo de requisição	URL
`GET`	`{{url_base}}/proposals/{proposalId}/documents`

Exemplo de URL (staging):

https://stg-api.creditas.io/b2b/proposals/{proposalId}/documents

Exemplo de URL (production):

https://api.creditas.io/b2b/proposals/{proposalId}/documents

Headers

Header	Valor
`Authorization`	`Bearer {{AUTHENTICATION_TOKEN}}`

🔑
Para detalhes sobre como obter o token JWT, consulte a página Autenticação e Ambientes.

Parâmetros da requisição

Parâmetro	Tipo	Obrigatório	Descrição
`proposalId`	String	Sim	Identificador único da proposta (path param).

Exemplo de requisição

curl --location 'https://stg-api.creditas.io/b2b/proposals/B2B-2DE59E35-3D1D-4829-83BB-D07FB0EB04FC/documents' \
  --header 'Authorization: Bearer {{your_access_token}}'

Resposta de sucesso — `200 OK`

{
    "items": [
        {
            "id": "DOC-8052AAA9-BA51-4DB8-A1E5-A736B5A3DCB1",
            "type": "PROOF_IDENTITY",
            "subject": "BORROWER"
        },
        {
            "id": "DOC-196634C2-243D-4108-B783-9A6C1F689C82",
            "type": "PROOF_IDENTITY",
            "subject": "BORROWER"
        }
    ],
    "cursors": {}
}

Campos da resposta

Campo	Tipo	Descrição
`items`	Array	Lista de documentos enviados para a proposta. Vazio (`[]`) caso nenhum tenha sido enviado.
`items[].id`	String	Identificador único do documento.
`items[].type`	String	Tipo do documento enviado. Veja tabela de tipos abaixo.
`items[].subject`	String	Titular ao qual o documento pertence. Veja tabela de titularidade abaixo. Omitido quando nulo.
`cursors`	Object	Objeto de paginação. Retornado sempre vazio (`{}`). ⚠️ Paginação pendente de implementação.

Tipos de documento (`type`)

Valor	Descrição
`INCOME_STATEMENT`	Comprovante de Renda
`PROOF_RESIDENCE`	Comprovante de Residência
`PROOF_IDENTITY`	Documento de Identidade
`INCOME_TAX`	Declaração de Imposto de Renda
`STABLE_UNION_CERTIFICATE`	Certidão de União Estável
`REAL_ESTATE_REGISTRATION`	Matrícula do Imóvel
`IPTU`	IPTU

Titularidade do documento (`subject`)

Valor	Descrição
`BORROWER`	Tomador principal da proposta
`SPOUSE`	Cônjuge do tomador
`COLLATERAL`	Garantia (imóvel)

Respostas de erro

Código	Descrição
`401`	Token de autenticação ausente, inválido ou expirado.
`404`	Proposta não encontrada para o `proposalId` informado.

Updated about 8 hours ago