---
title: "Read the candidate images out of a brand pack"
type: reference
method: POST
path: /rest-api/white-label/brand-images.do
tag: "White Label"
---

# Read the candidate images out of a brand pack

`POST https://YOUR-NETWORK-DOMAIN/rest-api/white-label/brand-images.do`

Answers the images in what you send — a ZIP of files, a single image, or a link to a brand page, whose drawn images, declared icons, preview images, CSS backgrounds, linked image files and inline data-URI images are all candidates. Each answer carries the file's own name, what it turned out to be, where it was found and its bytes base64-encoded. Nothing is stored and no slot is decided here: the console measures each candidate and proposes a slot for it, and every accepted file goes through the white-label image upload, which applies its own rules. Send exactly one of file or url. Requires the WHITE_LABEL admin permission.

## Query params

| Name | Type | Required | Example | Description |
|---|---|---|---|---|
| `url` | string | no | `https://www.example.com/brand` | A public http(s) link to the brand's page, or to one image or ZIP |

## Body

A multipart form: `file` (file).

## Responses

- `200` — {images: [{name, contentType, origin, bytes}], total, more, source: {kind, origin}}
- `400` — Field errors under 'errors': none or both of file and url; the source empty, larger than the limit, of a kind that cannot be read, a PDF (its images cannot be extracted here), not downloadable, or holding no images at all
- `401` — Authentication error
- `403` — Insufficient permissions, naming the missing one

## Example request

```bash
curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/white-label/brand-images.do?url=https%3A%2F%2Fwww.example.com%2Fbrand' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --form 'file=@data.csv'
```

Source: https://epom.com/ad-server/docs/api/white-label/post-white-label-brand-images