Skip to content

Download Profile Attachment By Profile And Attachment Id

Request

Gets profile attachment's download link.

Security
bearerToken
Path
profileIdstring, (uuid)required

Id of a profile.

Example:9a7ae0c8-f473-4ab6-8dbb-03fc061630cc
attachmentIdstring, (uuid)required

Id of an attachment.

Example:24faad02-7e20-4912-bdd9-51e4797380c5
Headers
X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97
curl -i -X GET \
  https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/profiles/9a7ae0c8-f473-4ab6-8dbb-03fc061630cc/attachments/24faad02-7e20-4912-bdd9-51e4797380c5/download \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json
downloadUrlstring

Url of the file to download

Example:"https://kyc-protect-api-test.s3.eu-west-1.amazonaws.com/customers/103077765/profiles/2770ac31-8d12-4f69-8f93-326e93cd8c34/attachments/103077765.10156
fileNamestring

Name of the file

Example:"NL-X-170661060000.pdf"
expiresAtstring, (date-time)

Date and time when the url will expire

Example:"2023-08-09T08:06:34.3212061Z"
correlationIdstring

A unique ID assigned to this request.

Example:"ee4228cc-68ed-413a-a547-79c5703017eb"
Response
{ "downloadUrl": "https://kyc-protect-api-stage.s3.eu-west-1.amazonaws.com/attachments/profiles/customers/100000002/8cb4d8a3-d277-4205-9d6c-f3f3a8b65f31/100000002.100000001.registrationDocuments.0050b9a6-8ba7-4279-8e63-b69211b77adf.txt", "fileName": "openapi-test.txt", "expiresAt": "2026-11-03T15:40:16.288Z", "correlationId": "390a3237-adf1-4de0-826b-c719f3e119d7" }