So fast and easy!
API Integration
Automate ID badge creation and ordering
Connect your HR system, onboarding workflow, event registration platform, or custom application to QuickIDCard. Use our REST API to create personalized badge instances from your saved templates, preview pricing, and place print orders — without designing each card by hand.
Who is this for?
- HR & onboarding platforms — trigger badge orders when a new hire is added
- Event & membership systems — issue attendee or member badges from registration data
- Custom portals — let customers or partners order badges from your own UI
- High-volume programs — replace one-by-one design with template-driven automation
Getting started (no account yet?)
You will need a free QuickIDCard account to create API keys and enable templates. Follow these steps once you are ready to build.
-
Create your QuickIDCard account
Sign up for a free account — there is no setup fee and no minimum order. Your account is where you manage API keys, badge templates, and field mappings.
-
Design your API badge templates
In the online badge creator, design and save the card layouts you want to automate. Each saved template acts as a source template — every API call copies it and applies the field values you send. Plan for long names, portrait photos, and one template per role or layout.
-
Create API keys and map template fields
After signing in, open My Account → API Integration. Generate a test key first, then assign API label IDs to each text and image layer on your templates and enable them for API use.
-
Review the API documentation
The full endpoint reference, request formats, and OpenAPI specification are available in your account after sign-in.
-
Test your integration
Using your test API key, walk through the typical flow:
GET /api/v2/health— confirm your key worksGET /api/v2/templates— list API-enabled templatesPOST /api/v2/badges— create a customized badge instance (text plus photo URL or data URI)POST /api/v2/orders/quote— preview pricingPOST /api/v2/orders— place an order (test keys return mock responses; live orders are reviewed before print)
-
Go live
Switch to a production API key and repeat the same flow. Use the
Idempotency-Keyheader when creating orders to safely retry requests. Every live order is reviewed by our team before printing to ensure text fit, portrait placement, and print quality.
Authentication, shipping, and limits
- Auth:
Authorization: Bearerwith a test or live key created in My Account. - Payment on live orders: store credit or purchase order, as documented in OpenAPI.
- Photos: HTTPS URL or data URI on badge image fields.
- Fulfillment: one shipping address per order; API addresses are United States only.
- Webhooks: none documented for partner integrations. Poll
GET /api/v2/orders/:idfor status. - Errors: standard HTTP error responses; see signed-in OpenAPI for schemas. Do not treat undocumented endpoints as supported.
Frequently asked questions
What does the QuickIDCard API do?
REST API v2 creates personalized badge instances from saved templates, returns quotes, and places print orders. Typical uses are HR onboarding, event registration, and custom portals. Full OpenAPI docs are in the signed-in account.
How does authentication work?
Send an Authorization Bearer token. Test keys (qic_test_ prefix) are for development; production keys (qic_live_) place real orders. There is no separate sandbox host—test keys return mock responses on order endpoints.
Can I submit employee photos through the API?
Yes. Badge photo fields accept an HTTPS URL or a data URI, as documented in the signed-in OpenAPI spec.
Does the API support webhooks?
No partner webhooks are documented. Poll order endpoints for status. Shopify webhooks on the site are an internal store integration, not the public badge API.
Where does the API ship?
API v2 shipping addresses are documented as United States only. Website checkout can use international rates on the pricing page.
Prefer a hands-on workflow?
If you do not need automation yet, you can still design badges online, upload your own artwork, or use our free batch processing for 25+ badges from a spreadsheet.
What customers say
5,615+ verified reviews · 4.8/5 average
Simple and efficient
Good company. Makes nice ID cards. Ships same day and arrives quickly.