Skip to main content

FileDownloadResult

Possible responses when asking for a download link.

A missing document is reported per field — as DocumentNotAvailableError where the field is non-null, as null where it is nullable — so one absent document never fails the surrounding offer query.

union FileDownloadResult = DocumentNotAvailableError | FileDownload | UnauthorizedOperationError

Possible types​

FileDownloadResult.DocumentNotAvailableError object​

The offer carries no such document right now.

A document reaches this API in two steps: the insurance system generates it, and our next offer sync copies it onto the offer. Until both have happened the document does not exist here, so poll the field again later. This says nothing about your API key's permissions — that case is UnauthorizedOperationError.

FileDownloadResult.FileDownload object​

Represents a secure, time-limited download link for a file.

  • Download links expire after 5 minutes
  • Links are pre-signed and do not require authentication.

FileDownloadResult.UnauthorizedOperationError object​

Error indicating the partner lacks required authorization for the requested operation.

Common causes:

  • Missing permissions to sell the specific product
  • Missing permission to read policies
  • Reading the policies of sub-brokers without entire-tree access

Member Of​

Offer object