> For the complete documentation index, see [llms.txt](https://docs.thewalletcrew.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.thewalletcrew.io/api-reference/internal.md).

# Internal

Internal platform endpoints used by The Wallet Crew infrastructure, the back-office, and the enrolment front-end. These are \*\*not intended for external integrations\*\*. They are documented here for transparency and for teams building white-label or embedded experiences on top of the platform.

Internal platform endpoints used by The Wallet Crew infrastructure, the back-office, and the enrolment front-end. These are **not intended for external integrations**. They are documented here for transparency and for teams building white-label or embedded experiences on top of the platform.

### Admin

Back-office management endpoints. Used by the admin console to manage users, roles, permissions, and platform-level settings. Require elevated scopes (typically Global Administrator or Tenant Administrator).

### CachedContent

Serves pre-rendered pass content (Apple `.pkpass` bundles, Google Wallet JWT payloads, download pages) from the platform cache. These endpoints are called by the Cinto SDK and by hosted download pages — not by API integrations.

> Caching is transparent to API callers. Pass updates through the standard Pass API automatically invalidate the relevant cached entries.

### Public

Unauthenticated or lightly authenticated endpoints that serve public-facing content: enrolment form assets, hosted download pages, and the `/.well-known` device-registration endpoints required by Apple Wallet for push notification delivery.

### Receipt

Generates and serves digital receipts linked to a pass. Used in post-transaction flows where a receipt should be displayed or delivered alongside a wallet pass update.

### Warmup

Platform health and warmup probes. Called by infrastructure on startup and by load balancers to verify that the service is ready to handle traffic. Returns a simple `200 OK` when healthy.

### A note on scope

Endpoints in this group require internal scopes that are not available to tenant API keys. If you are building an integration that seems to require access to one of these endpoints, there is usually a public API equivalent — check the **Pass Management**, **Forms**, or **Tools** groups first.

### Further reading

* [Platform infrastructure overview](https://docs.thewalletcrew.io/developers-guides/pass-architecture/infrastructure)
* [Pass data and sync](https://docs.thewalletcrew.io/developers-guides/pass-architecture/pass-data-and-sync)
* [Security overview](https://docs.thewalletcrew.io/policies/privacy-and-security)


---

# 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.thewalletcrew.io/api-reference/internal.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.
