Skip to main content

Get Attachments

Description​

Quote Requests may include relevant documentation as attachments. You can retrieve these attachment by ID via this authenticated API endpoint.

Endpoint​

Staging​

https://partner-engine-uat.beta.boldpenguin.com/attachments/<attachment_id>

Production​

https://partner-engine.boldpenguin.com/attachments/<attachment_id>

Authentication​

This endpoint requires an access_token from the authentication endpoint in the same environment. Include it as a bearer token in an Authorization header for the request.

Methods​

GET

Request Syntax​

/attachments/<attachment_id>

URL Parameters​

The URL corresponds to the id of the attachment from the webhook payload and will depend on the event that the partner receives. The partner can take the id from either the application_form:finished_quoting or quote_request:finished event to download the file.

Response​

This endpoint returns the attachment.

Examples​

Example Request​

curl --request GET \
  --url https://partner-engine.boldpenguin.com/attachments/f6d890d9-a381-449d-bc07-8f1b3c7365bf
  --header 'authorization: Bearer CKM6LKm965bghfSSPESbac39' \

Example Response​

< HTTP/2 200
< date: Fri, 17 Jul 2020 13:55:49 GMT
< content-type: application/pdf

NOTE: The content-type is shown as pdf in the example response, but it is a dynamic value which could represent other file types.