Customers
Get document download URL
:::info Customers API v2 The new customer onboarding flow is recommended for all new integrations.
If you already have an existing integration with Customers API v1, you can continue using it. BVNK will continue to support this API going forward. :::
Retrieves a temporary URL for document download.
get/platform/v1/customers/documents/{documentReference}/url
Request
- Base URLhttps://api.sandbox.bvnk.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
documentReferencestring uuid required
Example:0a184641-30e2-4414-871f-3db1c683900e
Internal document identifier
Response
successful operation
string uri required
Temporary link to the requested document
Example response
"https://my-app-filestore.s3.eu-west-1.amazonaws.com/com.customer.document.model.CustomerDocumentValue/34d5b0e3-8fb9-4f4e-86c5-3a438388c1c0.pdf?X-Amz-Security-Token=AKIAIOSFODNN7EXAMPLE&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20250528T153951Z&X-Amz-SignedHeaders=host&X-Amz-Expires=60&X-Amz-Credential=AKIAIOSFODNN7EXAMPLE%2F20250528%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890"
Changes
No recorded changes to this operation across all 3 revisions of this API.