> ## Documentation Index > Fetch the complete documentation index at: https://docs.anny.co/llms.txt > Use this file to discover all available pages before exploring further. # Register terminal reader > Registers a new Stripe Terminal reader using the pairing code displayed on the device screen. After the first reader is successfully registered, `is_terminal_enabled` on the payment account becomes `true` automatically. **Required:** `registration_code` (or `provider_reader_id`), `location` relationship ## OpenAPI ````yaml /developers/openapi/admin-internal.openapi.json post /api/v1/terminal-readers openapi: 3.1.0 info: title: admin-api version: '1.0' description: >- The Admin API gives you **full programmatic access** to your anny organization. It is built for **server-side integrations** — backend services, automation scripts, and custom tooling that act on behalf of your team. --- ## When to use the Admin API Use the Admin API when you need to **drive workflows from your own systems**: - **Sync membership data** — create or update customers, assign them to communities, reflect subscription status from an external CRM - **Create bookings programmatically** — build back-office tools or automate repeat reservations without going through the customer checkout - **Issue and forward invoices** — generate invoices, send them to customers, or push them to your accounting system - **React to real-time events** — pair the API with [Webhooks](/developers/guides/admin/webhooks) to trigger side effects whenever a booking is created, cancelled, or checked in - **Drive display panels** — push live occupancy and schedule data to digital signage or lobby displays Combined with [webhook subscriptions](/developers/guides/admin/webhooks), you can build fully automated, event-driven workflows without polling. --- ## Authentication Generate a long-lived API token directly in the admin dashboard under **Organization Settings → API**. All requests require it in the `Authorization` header: ``` Authorization: Bearer {access_token} ``` Every endpoint is **organization-scoped**. Pass your organization ID as a query parameter on every request: ``` ?o={organization_id} ``` See the [Authentication guide](/developers/guides/authentication) for token scopes and the full OAuth2 flow. --- ## Admin API vs Customer API | | Admin API | Customer API | |---|---|---| | **Use case** | Server-side automation, backend tooling | End-user apps, booking widgets | | **Auth** | Required — API token or OAuth2 | Optional — many endpoints work without a token | | **Identifiers** | Immutable UUIDs and integer IDs | Slugs, booking numbers, order numbers | | **Access** | Full read/write | Public and customer-owned data only | → [Go to the Customer API](/developers/api-reference/customer) --- ## Resource Identifiers The Admin API uses **immutable IDs** — UUIDs for most entities, integers for legacy ones. These are safe to store in external systems and never change, even if an organization renames a resource. --- ## Starting Points | Guide | What it covers | |---|---| | [Getting Started](/developers) | First steps and quickstart | | [JSON:API Conventions](/developers/guides/json-api-conventions) | Request and response format | | [Authentication](/developers/guides/authentication) | API tokens, OAuth2, scopes | | [Availability & Booking Search](/developers/guides/availability) | Search open slots and timeslots | | [Admin Booking Creation](/developers/guides/admin/booking-creation) | Create bookings from the back office | | [Admin Booking Edit](/developers/guides/admin/booking-edit) | Edit resource, dates, fields, add-ons, and sub-bookings | | [Admin Booking Lifecycle](/developers/guides/admin/booking-lifecycle) | Status changes, check-in, cancellations | | [Invoices](/developers/guides/admin/invoices) | Create, send, and manage invoices | | [Customer Management](/developers/guides/admin/customer-management) | Create and manage customer records | | [Booking Calendars](/developers/guides/admin/calendar-events) | Custom calendar events | | [Timeslot Management](/developers/guides/admin/timeslot-management) | Manage timeslot CRUD, recurrence, allocations, and rescheduling | | [Broadcast Campaigns](/developers/guides/admin/broadcasting) | Email and push campaigns | | [Exports](/developers/guides/admin/exports) | Export bookings and customer data | | [Webhooks & Events](/developers/guides/admin/webhooks) | Subscribe to real-time events | --- ## Base URLs | Environment | URL | |---|---| | Production | `https://b.anny.co` | | Gov-Cloud | `https://b.anny.eu` | contact: name: anny GmbH url: https://anny.co email: support@anny.co servers: - url: https://b.anny.co description: Production - url: https://b.anny.eu description: Gov-Cloud security: - Bearer: [] tags: - name: Booking Quotas - name: Orders - name: Organizations - name: Table Configuration - name: Test-Results - name: User Settings - name: Terminal Locations - name: Terminal Readers - name: Connection Tokens - name: Views - name: Voice Integration paths: /api/v1/terminal-readers: post: tags: - Terminal Readers summary: Register terminal reader description: > Registers a new Stripe Terminal reader using the pairing code displayed on the device screen. After the first reader is successfully registered, `is_terminal_enabled` on the payment account becomes `true` automatically. **Required:** `registration_code` (or `provider_reader_id`), `location` relationship operationId: create-terminal-reader parameters: - schema: type: string in: query name: o description: Organization ID requestBody: required: true content: application/vnd.api+json: schema: type: object required: - data properties: data: type: object required: - type - attributes - relationships properties: type: type: string default: terminal-readers attributes: type: object properties: registration_code: type: string description: >- Pairing code shown on the reader screen. Required unless `provider_reader_id` is provided. example: puppies-plug-could provider_reader_id: type: string description: >- Stripe reader ID (`tmr_...`). Alternative to `registration_code` for re-linking known readers. label: type: - string - 'null' description: Human-readable label for the reader example: Front Desk Reader relationships: type: object required: - location properties: location: type: object required: - data properties: data: type: object required: - type - id properties: type: type: string default: terminal-locations id: type: string format: uuid examples: simulated: summary: Register simulated reader (testing) value: data: type: terminal-readers attributes: registration_code: simulated-wpe label: Test Reader relationships: location: data: type: terminal-locations id: 00000000-0000-0000-0000-000000000000 physical: summary: Register physical reader value: data: type: terminal-readers attributes: registration_code: puppies-plug-could label: Front Desk Reader relationships: location: data: type: terminal-locations id: 00000000-0000-0000-0000-000000000000 responses: '201': description: Created content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/terminal-readers.v1' '401': description: Unauthorized '422': description: Unprocessable Entity security: - Bearer: [] components: schemas: terminal-readers.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.0.0 title: TerminalReader type: object description: A physical Stripe Terminal card reader registered to an organization. x-tags: - Models properties: id: type: string format: uuid type: type: string default: terminal-readers attributes: type: object properties: label: type: - string - 'null' description: Human-readable label for the reader provider_reader_id: type: - string - 'null' description: Stripe reader ID (e.g. `tmr_...`) serial_number: type: - string - 'null' description: Hardware serial number printed on the device device_type: type: - string - 'null' description: >- Stripe device type identifier (e.g. `stripe_s700`, `bbpos_wisepos_e`, `apple_built_in`) device_sw_version: type: - string - 'null' description: Firmware / software version reported by the device ip_address: type: - string - 'null' description: Current IP address of the reader on the local network status: type: - string - 'null' enum: - online - offline description: Reader connectivity status as reported by Stripe is_tap_to_pay: type: boolean description: Whether this reader is a Tap to Pay (software-only) reader is_synced: type: boolean description: Whether the reader has been successfully synced to Stripe display_label: type: string description: >- Formatted display label combining label and device type (e.g. `Reader 1 (S700)`) last_seen_at: type: - string - 'null' format: date-time description: Timestamp of the last known reader activity created_at: type: string format: date-time description: ISO 8601 creation timestamp updated_at: type: string format: date-time description: ISO 8601 last-update timestamp links: $ref: '#/components/schemas/links.v1' relationships: type: object properties: location: type: object description: Terminal location this reader is assigned to properties: data: type: - object - 'null' properties: type: type: string id: type: string format: uuid links: $ref: '#/components/schemas/links.v1' payment_account: type: object description: Payment account this reader belongs to properties: data: type: - object - 'null' properties: type: type: string id: type: string format: uuid links: $ref: '#/components/schemas/links.v1' links.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.1.0 title: ResourceLinks x-tags: - Models type: object description: JSON:API self-link object properties: self: type: string format: uri securitySchemes: Bearer: type: oauth2 flows: authorizationCode: authorizationUrl: https://auth.anny.co/oauth/authorize tokenUrl: https://auth.anny.co/oauth/token refreshUrl: https://auth.anny.co/oauth/token/refresh scopes: {} ````