Listar Documentos

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

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

🔑

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

Parâmetros da requisição

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

Tipos de documento (type)

Titularidade do documento (subject)

Respostas de erro