Retrieving Quote Request Attachments
Quote Request Attachments
The terminal returns a quote request event whenever it reaches out to
a carrier to retrieve quote information. You subscribe to these events using our
Webhook API. Under certain
circumstances, quote requests include form attachments. In
these cases the webhook event payload includes an
attachment_id you can use to
retrieve the attachment via our API.
Here is a snippet of a quote request payload that includes a PDF attachment:
Once you have an
attachment_id, you can either display or store the
attachments for review using the Bold Penguin API.
Bold Penguin API requests are authorized using ephemeral authentication tokens.
You receive a token when you send an OAuth2
client_credentials type grant
request to the authentication endpoint for your terminal. You must include
your clients credentials in either a Basic Auth header or POST parameters
within this grant request.
Upon successful authentication, you will receive an ephemeral access token in the response that you will provide in the authorization header for additional API requests. Tokens are valid for 12 hours. For more information, see Authentication.
Once authenticated, you can retrieve an existing
attachment_id from a quote
request event using the Get
Attachments API. The response payload will match the
attachment_type from the quote request event.