Quick Start

Base URL

Use the base URL that matches your qid environment:

Environment	Base URL
Production	`https://api.qidpro.xyz`
Staging	`https://staging.qidpro.xyz`

All endpoint paths in this documentation are relative to the base URL above. For example, creating a share in production:

curl --request POST 'https://api.qidpro.xyz/di/share'

Authenticate requests

To use qid Cloud APIs, you need to generate Auth Keys from your organization dashboard.

Go to Settings > API Keys > Create Key.
You will be provided with a Token ID and Secret Key.
Save the Secret Key securely; it cannot be retrieved again from the dashboard.
Include the key in the request header for each request.

Required headers

Header	Required	Description
`Authorization`	Yes	`Bearer {Secret Key}`
`tokenId`	Yes	Token ID from the dashboard

Example

Production:

curl 'https://api.qidpro.xyz/di/document/list?email=user%40example.com' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id'

Staging:

curl 'https://staging.qidpro.xyz/di/document/list?email=user%40example.com' \
  --header 'Authorization: Bearer your-secret-key' \
  --header 'tokenId: your-token-id'

Get started

After authenticating your requests, choose the guide for the workflow you want to build.

Guide	What you'll do
Documents	Create, read, list, and scan identity documents
Collection Request	Create and Read collection requests
Share	Get the guest data shared with *qid*
Webhook	Receive real-time event notifications