Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
ProfileDocument

Get document download URL

Get a pre-signed URL for downloading the document file (valid for 5 minutes)

get/group-profile/v1/profiles/{profileId}/documents/{documentId}/download

Path parameters

profileIdinteger required

Entity ID

documentIdinteger required

Document ID

Headers

x-property-idinteger

Property ID

x-organization-idinteger required

Organization ID

Response

Pre-signed download URL generated successfully

downloadUrlstring uri required

Pre-signed URL to download the document file (valid for 5 minutes)

Example response

{
  "downloadUrl": "https://s3.amazonaws.com/bucket/path/file.pdf?X-Amz-..."
}