# API integration

> Markdown version of [API integration](https://www.quickidcard.com/api-integration). Site index: [llms.txt](https://www.quickidcard.com/llms.txt). Full reference: [llms-full.txt](https://www.quickidcard.com/llms-full.txt).
> Last updated: 2026-08-22


REST API v2 for automated badge ordering from HRIS, onboarding, event registration, or custom applications. Create personalized badge instances from saved templates, preview pricing, and place print orders without designing each card by hand.

## Facts

- Free to integrate; no setup fee and no minimum order on the QuickIDCard account
- Auth: `Authorization: Bearer` (`qic_test_` development keys; `qic_live_` production)
- Test keys return mock responses on order endpoints. There is **no separate sandbox host**
- Live orders are reviewed before printing
- Photos: HTTPS URL or data URI
- Payment on live orders: store credit or purchase order (OpenAPI)
- Shipping: **United States only** on API v2 (website checkout may use international rates)
- **No documented partner webhooks** — poll `GET /api/v2/orders/:id`
- Use the `Idempotency-Key` header when creating orders

## Typical request flow

- `GET /api/v2/health`
- `GET /api/v2/templates`
- `POST /api/v2/badges`
- `POST /api/v2/orders/quote`
- `POST /api/v2/orders`

Signed-in OpenAPI lists additional read endpoints (`account`, `templates/:id`, `badges`, `accessories`, `orders`).

Signed-in OpenAPI and field mapping: https://www.quickidcard.com/myaccount/api-integration

## FAQ

**Webhooks?** Not documented for partners.

**International API shipping?** Not in API v2 (USA/US only).

HTML overview: https://www.quickidcard.com/api-integration