# API reference

> Every endpoint of the SightRadar Face Recognition API, generated from the OpenAPI 1.0.0 specification.

Source: https://sightradar.com/docs/api

Base URL `https://api.sightradar.com`. Every `/v1/*` endpoint authenticates with `Authorization: Bearer frs_<prefix>_<secret>`; see [Authentication](/docs/authentication) to get a key. The machine-readable spec is at [/openapi.json](/openapi.json), and the [playground](/docs/playground) lets you call any endpoint with your own key.

- [Collections](/docs/api/collections): Create and manage face collections (the registry of your indexed photos).

- [Faces](/docs/api/faces): Index, search, detect, and compare faces (billable operations).

- [Selfies](/docs/api/selfies): Register a single-face selfie for later search-by-id.

- [Batch](/docs/api/batch): Asynchronous bulk processing with webhook callbacks.

- [Webhooks](/docs/api/webhooks): Register endpoints for per-photo batch results and verified deletion completion events.

- [Wallet & Usage](/docs/api/wallet-and-usage): Check your credit balance, usage, and auto-recharge config.

- [Health](/docs/api/health): Liveness and readiness probes (unauthenticated).

## All endpoints

| Method   | Path                                            | Operation                                                                                                         |
| -------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- |
| `GET`    | `/v1/collections`                               | [List collections](/docs/api/collections/list-collections)                                                        |
| `POST`   | `/v1/collections`                               | [Create a collection](/docs/api/collections/create-a-collection)                                                  |
| `GET`    | `/v1/collections/{id}`                          | [Describe a collection](/docs/api/collections/describe-a-collection)                                              |
| `DELETE` | `/v1/collections/{id}`                          | [Delete a collection (soft by default, restorable)](/docs/api/collections/delete-a-collection)                    |
| `POST`   | `/v1/collections/{id}/restore`                  | [Undo a soft collection delete](/docs/api/collections/undo-a-soft-collection-delete)                              |
| `POST`   | `/v1/collections/{id}/photos/{photoId}/restore` | [Undo a soft photo delete](/docs/api/collections/undo-a-soft-photo-delete)                                        |
| `GET`    | `/v1/collections/{id}/deletion`                 | [Get collection deletion status](/docs/api/collections/get-collection-deletion-status)                            |
| `GET`    | `/v1/collections/{id}/metrics`                  | [Collection metrics](/docs/api/collections/collection-metrics)                                                    |
| `DELETE` | `/v1/collections/{id}/photos/{photoId}`         | [Delete one photo's faceprints (soft by default, restorable)](/docs/api/collections/delete-one-photos-faceprints) |
| `POST`   | `/v1/collections/{id}/index`                    | [Index faces from a photo](/docs/api/faces/index-faces-from-a-photo)                                              |
| `POST`   | `/v1/collections/{id}/search`                   | [Search a collection](/docs/api/faces/search-a-collection)                                                        |
| `POST`   | `/v1/collections/{id}/search-by-id`             | [Search by a stored selfie point id](/docs/api/faces/search-by-a-stored-selfie-point-id)                          |
| `POST`   | `/v1/detect`                                    | [Detect faces (no storage)](/docs/api/faces/detect-faces)                                                         |
| `POST`   | `/v1/compare`                                   | [Compare two faces](/docs/api/faces/compare-two-faces)                                                            |
| `POST`   | `/v1/collections/{id}/selfies`                  | [Register a selfie](/docs/api/selfies/register-a-selfie)                                                          |
| `GET`    | `/v1/batches`                                   | [List batches](/docs/api/batch/list-batches)                                                                      |
| `POST`   | `/v1/batches`                                   | [Submit a batch job](/docs/api/batch/submit-a-batch-job)                                                          |
| `POST`   | `/v1/batches/failed/requeue`                    | [Preview or execute a failed-photo retry wave](/docs/api/batch/preview-or-execute-a-failed-photo-retry-wave)      |
| `POST`   | `/v1/batches/statuses`                          | [Get statuses for an explicit batch set](/docs/api/batch/get-statuses-for-an-explicit-batch-set)                  |
| `GET`    | `/v1/batches/{id}`                              | [Get batch status](/docs/api/batch/get-batch-status)                                                              |
| `GET`    | `/v1/batches/{id}/photos`                       | [Get per-photo batch results](/docs/api/batch/get-per-photo-batch-results)                                        |
| `GET`    | `/v1/webhooks`                                  | [List webhook endpoints](/docs/api/webhooks/list-webhook-endpoints)                                               |
| `POST`   | `/v1/webhooks`                                  | [Register a webhook endpoint](/docs/api/webhooks/register-a-webhook-endpoint)                                     |
| `DELETE` | `/v1/webhooks/{id}`                             | [Disable a webhook endpoint](/docs/api/webhooks/disable-a-webhook-endpoint)                                       |
| `GET`    | `/v1/webhooks/dead-letters`                     | [List dead-lettered webhook deliveries](/docs/api/webhooks/list-dead-lettered-webhook-deliveries)                 |
| `POST`   | `/v1/webhooks/dead-letters/replay`              | [Replay dead-lettered webhook deliveries](/docs/api/webhooks/replay-dead-lettered-webhook-deliveries)             |
| `GET`    | `/v1/wallet`                                    | [Get credit balance](/docs/api/wallet-and-usage/get-credit-balance)                                               |
| `GET`    | `/v1/usage`                                     | [Usage report](/docs/api/wallet-and-usage/usage-report)                                                           |
| `GET`    | `/v1/usage/daily`                               | [Daily usage time series](/docs/api/wallet-and-usage/daily-usage-time-series)                                     |
| `GET`    | `/health`                                       | [Liveness probe (alias of /healthz)](/docs/api/health/liveness-probe)                                             |
| `GET`    | `/healthz`                                      | [Liveness probe](/docs/api/health/get-healthz)                                                                    |
| `GET`    | `/readyz`                                       | [Readiness probe](/docs/api/health/readiness-probe)                                                               |