Consultar Detalhes (Link) do Documento

Utilize este endpoint para obter um link temporário de visualização ou download de um documento já enviado para uma proposta de crédito.

Para obter o documentId necessário nesta requisição, consulte a página Listar Documentos, que retorna todos os documentos associados a uma proposta.

Pré-requisitos

Antes de consultar o link de um documento, certifique-se de que:

• O documento foi previamente enviado e possui um documentId válido. Consulte a página Listar Documentos para obter os identificadores dos documentos de uma proposta.

Sobre o link retornado

O link retornado é uma URL pré-assinada (presigned URL) gerada pelo Amazon S3. Algumas características importantes:

⚠️

Atenção: Não armazene ou compartilhe o link por períodos longos — ele expira em 10 minutos. Sempre que precisar acessar o documento, gere um novo link realizando a requisição novamente.

📋

Rastreabilidade: Cada solicitação de link é registrada internamente pela Creditas. Mantemos um histórico de quando o link de cada documento foi solicitado pela última vez, garantindo rastreabilidade total sobre o acesso aos arquivos da proposta.

Endpoint

Exemplo de URL (staging):

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

Exemplo de URL (production):

https://api.creditas.io/b2b/documents/{documentId}

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/documents/DOC-196634C2-243D-4108-B783-9A6C1F689C82' \
  --header 'Authorization: Bearer {{your_access_token}}'

Resposta de sucesso — 200 OK

A resposta é uma string contendo diretamente a URL pré-assinada do documento, sem envelope JSON.

"https://creditas-documents.s3.amazonaws.com/{document-key}?X-Amz-Security-Token=...&X-Amz-Expires=600&..."

ℹ️

O parâmetro X-Amz-Expires=600 presente na URL confirma que o link expira em 600 segundos (10 minutos).

Respostas de erro