> For the complete documentation index, see [llms.txt](https://docs.toolkit.equs.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.toolkit.equs.ai/api/control-api/allowed-origins.md).

# Allowed Origins

## Get Allowed Origins

> Fetches a page of the allowed origins registered by Tenants, one entry per origin, queryable via status and tenant params

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Control API Documentation","version":"0.1.2"},"tags":[{"name":"Allowed Origins","description":""}],"security":[{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"GetAllowedOriginsResponse":{"type":"object","properties":{"items":{"description":"The allowed origins on this page, one entry per origin.","type":"array","items":{"$ref":"#/components/schemas/AllowedOriginWithTenantResponse"}},"pagination":{"$ref":"#/components/schemas/PaginationData"}},"required":["items","pagination"]},"AllowedOriginWithTenantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Allowed origin unique ID"},"origin":{"type":"string","description":"Origin embeddable UI components may be served to."},"status":{"type":"string","description":"Review status of the origin. Pending while the Service Provider reviews it, which includes adding it to the Content-Security-Policy configuration; active once approved, when it is served to embeddable components; rejected when refused.","enum":["pending","active","rejected"]},"tenant":{"description":"Tenant the origin belongs to.","allOf":[{"$ref":"#/components/schemas/AllowedOriginTenantResponse"}]}},"required":["id","origin","status","tenant"]},"AllowedOriginTenantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tenant unique ID"},"name":{"type":"string","description":"Display name of the tenant."},"slug":{"type":"string","description":"URL-friendly slug of the tenant."}},"required":["id","name","slug"]},"PaginationData":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}},"required":["page","limit"]}}},"paths":{"/api/v1/allowed-origins":{"get":{"description":"Fetches a page of the allowed origins registered by Tenants, one entry per origin, queryable via status and tenant params","operationId":"AllowedOriginsController_getAllowedOrigins_api/v1","parameters":[{"name":"page","required":false,"in":"query","schema":{"default":1,"type":"number"}},{"name":"limit","required":false,"in":"query","schema":{"default":10,"type":"number"}},{"name":"status","required":false,"in":"query","description":"Returns only the origins carrying this review status.","schema":{"type":"string","enum":["pending","active","rejected"]}},{"name":"tenant","required":false,"in":"query","description":"Tenant unique ID","schema":{"type":"string"}}],"responses":{"200":{"description":"When Allowed Origins are retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllowedOriginsResponse"}}}}},"summary":"Get Allowed Origins","tags":["Allowed Origins"]}}}}
```

## Create Allowed Origin

> Adds a single origin to a Tenant on its behalf. Created as pending unless a status is given.

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Control API Documentation","version":"0.1.2"},"tags":[{"name":"Allowed Origins","description":""}],"security":[{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"CreateAllowedOriginRequest":{"type":"object","properties":{"tenantId":{"type":"string","description":"Tenant unique ID"},"origin":{"type":"string","description":"Origin that is allowed to embed wallet."},"status":{"type":"string","description":"Status to create the origin with. Defaults to pending.","enum":["pending","active","rejected"]}},"required":["tenantId","origin"]},"CreateAllowedOriginResponse":{"type":"object","properties":{"id":{"type":"string","description":"Allowed origin unique ID"},"origin":{"type":"string","description":"Origin embeddable UI components may be served to."},"status":{"type":"string","description":"Review status of the origin. Pending while the Service Provider reviews it, which includes adding it to the Content-Security-Policy configuration; active once approved, when it is served to embeddable components; rejected when refused.","enum":["pending","active","rejected"]},"tenant":{"description":"Tenant the origin belongs to.","allOf":[{"$ref":"#/components/schemas/AllowedOriginTenantResponse"}]}},"required":["id","origin","status","tenant"]},"AllowedOriginTenantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tenant unique ID"},"name":{"type":"string","description":"Display name of the tenant."},"slug":{"type":"string","description":"URL-friendly slug of the tenant."}},"required":["id","name","slug"]}}},"paths":{"/api/v1/allowed-origins":{"post":{"description":"Adds a single origin to a Tenant on its behalf. Created as pending unless a status is given.","operationId":"AllowedOriginsController_createAllowedOrigin_api/v1","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAllowedOriginRequest"}}}},"responses":{"201":{"description":"When the allowed origin is created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAllowedOriginResponse"}}}},"404":{"description":"When the Tenant the origin is created for does not exist."},"409":{"description":"When the Tenant already has this origin."}},"summary":"Create Allowed Origin","tags":["Allowed Origins"]}}}}
```

## Set Allowed Origin Status

> Updates the review status of a single allowed origin and notifies the Tenant by email.

```json
{"openapi":"3.0.0","info":{"title":"EqusDTK Control API Documentation","version":"0.1.2"},"tags":[{"name":"Allowed Origins","description":""}],"security":[{"sp":[]}],"components":{"securitySchemes":{"sp":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Service Provider. Token of the Service Provider client in the `agents` realm, with no `tenantId` claim. Authorize one bearer scheme at a time."}},"schemas":{"UpdateAllowedOriginRequest":{"type":"object","properties":{"status":{"type":"string","description":"Review status to apply. Set it to active once the origin has been approved and added to the Content-Security-Policy configuration, or to rejected to refuse it. Any transition is allowed, so a rejected origin can be reinstated.","enum":["pending","active","rejected"]}},"required":["status"]},"UpdateAllowedOriginResponse":{"type":"object","properties":{"id":{"type":"string","description":"Allowed origin unique ID"},"origin":{"type":"string","description":"Origin embeddable UI components may be served to."},"status":{"type":"string","description":"Review status of the origin. Pending while the Service Provider reviews it, which includes adding it to the Content-Security-Policy configuration; active once approved, when it is served to embeddable components; rejected when refused.","enum":["pending","active","rejected"]},"tenant":{"description":"Tenant the origin belongs to.","allOf":[{"$ref":"#/components/schemas/AllowedOriginTenantResponse"}]}},"required":["id","origin","status","tenant"]},"AllowedOriginTenantResponse":{"type":"object","properties":{"id":{"type":"string","description":"Tenant unique ID"},"name":{"type":"string","description":"Display name of the tenant."},"slug":{"type":"string","description":"URL-friendly slug of the tenant."}},"required":["id","name","slug"]}}},"paths":{"/api/v1/allowed-origins/{id}":{"put":{"description":"Updates the review status of a single allowed origin and notifies the Tenant by email.","operationId":"AllowedOriginsController_setAllowedOriginStatus_api/v1","parameters":[{"name":"id","required":true,"in":"path","description":"Allowed origin unique ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAllowedOriginRequest"}}}},"responses":{"200":{"description":"When the review status of the allowed origin is applied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAllowedOriginResponse"}}}},"404":{"description":"When the allowed origin does not exist."}},"summary":"Set Allowed Origin Status","tags":["Allowed Origins"]}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.toolkit.equs.ai/api/control-api/allowed-origins.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.