Docs › Getting started

Getting access & approval

Sandbox, new businesses, and existing Dragonfly merchants.

Only approved merchants can send live orders. There are three ways in, depending on who you are.

You are…	How you get a key	Key prefix
Exploring or building	`POST /v1/signup` with `"sandbox": true`. The key is returned in the same response.	`dfk_test_`
A new business	`POST /v1/signup`. A Dragonfly admin reviews the application, and your first poll after approval returns the key.	`dfk_live_`
Already a Dragonfly merchant	Request access in the merchant portal. Once an admin approves it, the account owner creates keys there.	`dfk_live_`

Existing Dragonfly merchants

Sign in at merchants.trydragonfly.com/api-access.
Click Request API access. Say what you'll send (for example, "prescription deliveries from our pharmacy system, about 40 a day") and which system or agent will send it.
Dragonfly reviews the request, usually within one business day.
Once approved, the account owner clicks Create API key. The key and signing secret are shown once: copy them into your system or agent.
Revoke a key from the same page at any time. It stops working immediately.

Note: POST /v1/signup with an email that already belongs to a Dragonfly account answers 409 EMAIL_IN_USE and points here. A key is never handed to someone who merely knows a merchant's email address.

New businesses (self-serve)

bash

curl -s https://api.trydragonfly.com/v1/signup -H 'content-type: application/json' -d '{
  "businessName": "Oak Street Pharmacy",
  "contactName": "Dana Smith",
  "email": "[email protected]",
  "phone": "+14155550100",
  "vertical": "pharmacy",
  "pickupAddress": "870 Market St, San Francisco, CA 94102",
  "expectedWeeklyOrders": 200
}'

vertical is one of catering, restaurant, grocery, parcels, industrial_3pl, pharmacy, medical, meal_kits, other. It sets your default pricing; your account manager can adjust it.

The response carries an applicationId and a one-time pollToken. Poll every few minutes, not every few seconds:

bash

curl -s https://api.trydragonfly.com/v1/signup/APPLICATION_ID -H 'X-Signup-Token: POLL_TOKEN'

`status`	Meaning
`PENDING`	Waiting for review. Keep polling.
`REJECTED`	`reviewNotes` says why.
`APPROVED`	The first poll returns `apiKey` and `signingSecret`, exactly once. Later polls return `apiKeyClaimed: true`.

You also receive an invitation to the merchant portal, where you can see your orders, invoices and pricing.

Losing a key

Keys can't be retrieved: Dragonfly stores only a hash. Create a new key on the API access page (or ask support), then revoke the old one.

When access ends

A key stops working when it is revoked (401 UNAUTHORIZED) or when the merchant account is deactivated (403 MERCHANT_INACTIVE).

← PreviousQuickstart (5 minutes)Next →Authentication

Something unclear or missing? Tell us.