Skip to main content
GET
/
organisations
/
branding-logo
Get branding logo download URL
curl --request GET \
  --url https://api.uk.veridox.ai/organisations/branding-logo \
  --header 'x-api-key: <api-key>'
{
  "download_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
Retrieve a signed download URL for the current organisation logo/brand image. This endpoint returns a pre-signed SAS URL that allows direct access to the asset.
If no branding logo has been uploaded for your organisation, this endpoint will return a 404 Not Found error.

​
Best Practices

  1. URL Freshness: Download URLs are valid for 30 minutes. Always request a fresh URL before displaying the logo to users.
  2. Graceful Handling: Handle 404 responses by showing a default placeholder logo in your application.
  3. Member Access: Any authenticated member of the organisation can retrieve the branding logo.

Authorizations

​
x-api-key
string
header
required

Response

Branding logo URL retrieved successfully

​
download_url
string<uri>
required
​
expires_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$