---
title: "Compare candidate resources for one intended use"
method: POST
path: "/v1/compare"
tags: ["Rights desk"]
---

# Compare candidate resources for one intended use

`POST /v1/compare`

## Request

- Base URL: `https://www.rightshold.com`
- URL: `https://www.rightshold.com/v1/compare`
- Auth: one of:
  - none
  - HTTP bearer

## Headers

- `X-Request-Id` string

## Request body

- object
  - `resource_ids` string[], required
  - `intended_use` object: Intended use: every true flag is a right the check must find documented; omitted flags are false; unknown fields are refused. For instance {"commercial_use":true,"deployment":true,"attribution_planned":true,"duration_days":365}
    - `commercial_use` boolean
    - `redistribution` boolean
    - `modification` boolean
    - `sublicensing` boolean
    - `deployment` boolean
    - `model_training` boolean
    - `model_inference` boolean
    - `attribution_planned` boolean
    - `geography` string: worldwide (default) or a region code such as US, EU, UK
    - `duration_days` integer, nullable: Whole days of use (1 to 36500), or null for no fixed term

## Response `200`

OK

- object: Inferred from 3 recorded responses; required fields appeared in every one; additional properties may appear.
  - `assessments` object[], required
    - `resource_id` string, required
    - `disposition` string, required
    - `findings` object[], required
    - `existing_entitlement_id` unknown, required
    - `assessment_id` string, required
    - `explanation` object, required
      - `disposition` string, required
      - `label` string, required
      - `headline` string, required
      - `summary` string, required
      - `uses_evaluated` string[], required
      - `prohibited_uses` unknown[], required
        - unknown
      - `undocumented_uses` unknown[], required
        - unknown
      - `duties` unknown[], required
        - unknown
  - `ranking` object[], required
    - `rank` integer, required
    - `resource_id` string, required
    - `title` string, required
    - `disposition` string, required
    - `label` string, required
    - `existing_entitlement_id` unknown, required
    - `price_cents` unknown, required
    - `currency` string, required
    - `reason` string, required
    - `assessment_id` string, required
  - `recommended_resource_id` unknown, required

## Other responses

- `400`: Problem details: a stable error code, type URI, title, status and an explanation
- `401`: Problem details: a stable error code, type URI, title, status and an explanation
- `404`: Problem details: a stable error code, type URI, title, status and an explanation
- `405`: Problem details: a stable error code, type URI, title, status and an explanation
- `422`: Problem details: a stable error code, type URI, title, status and an explanation
- `429`: Request budget exhausted; retry after Retry-After seconds
- `500`: Problem details: a stable error code, type URI, title, status and an explanation

---

[API](https://skmtc.dev/rightshold/apis/rightshold-api.md) · [All operations](https://skmtc.dev/rightshold/apis/rightshold-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rightshold/apis/rightshold-api/revisions/cfe84fdde1ca?raw)