---
title: "Create Entitlements"
method: POST
path: "/v1/omni-ai/entitlements"
tags: ["Omni AI"]
---

# Create Entitlements

`POST /v1/omni-ai/entitlements`

Record consent and upsert one-or-more active grants.

## Request body

- CreateEntitlementsRequest
  - `account_ids` integer[], required
  - `agreement_id` string, required
  - `entitlement_codes` EntitlementCode[], required

## Response `200`

Resulting active grants for requested scope

- object
  - `error` ApiError — A direct mapping of tonic::Status, for use in HTTP responses.
    - `code` integer, required — The error code is used to identify the nature of the error. It corresponds to an HTTP status code.
    - `details` object[]
    - `message` string, required — A human-readable message providing more details about the error.
  - `metadata` ResponseMetadata, required — Metadata for the response. This will always contain a request ID which can be used to identify the request to Clear Street for tracing, and optionally may include pagination data.
    - `next_page_token` string, byte, nullable — Base64URL-encoded pagination token
    - `page_number` integer, nullable — Pagination. Included if this was a GET (list) response
    - `previous_page_token` string, byte, nullable — Base64URL-encoded pagination token
    - `request_id` string, required — A unique ID for this request, generated upon ingestion of the request.
    - `total_items` integer, nullable — Total number of items available (not just in this page).
    - `total_pages` integer, nullable — Total number of pages available.
  - `data` EntitlementResource[], required
    - `account_id` integer, required
    - `agreement_id` string, required
    - `entitlement_code` 'omni.account_data', required — Stable entitlement code granted by an agreement.
    - `entitlement_id` string, required
    - `granted_at` string, required

## Other responses

- `400` — Invalid request payload
- `403` — Caller lacks access to one or more requested accounts
- `500` — Internal server error

---

[API](https://skmtc.net/clear-street/apis/clear-street-trading-api.md) · [All operations](https://skmtc.net/clear-street/apis/clear-street-trading-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/clear-street/clear-street-trading-api/revisions/80e6fb2644e0/schema)