Skip to main content
Integrate with EZYiD using the External API at https://api-external.ezyid.io.

Generate an API key

In your EZYiD Dashboard, open Admin → My Preferences → API Key Configuration and generate an API key. Copy and store the generated key securely. Keys can have an expiry date and can be revoked from the same settings. Each key is associated with a SubscriberID. Data endpoints derive the subscriber from the API key and restrict asset and dataset lookups to that subscriber. You do not need to supply subscriberId when requesting asset custody history or querying datasets.

Use your API key

Supply apiKey as a query parameter. For POST query endpoints, send filters in the JSON body and keep the API key in the query string as documented on the endpoint page.
For chain of custody and dataset query endpoints, a missing key returns 400, an unknown key returns 404, and a revoked or expired key returns 401. Check the endpoint reference for its complete response codes.

Chain of custody

Retrieve history using an EZYiD, serial number, custom ID, or APK ID, or use the existing APK ID path route. Identifier lookup requires exactly one selector and returns 409 if more than one asset in the key’s subscriber matches.

Keep keys secure

Do not expose API keys in public repositories, client-side code, or public forums. Avoid recording full request URLs containing keys in logs. If a key is compromised, revoke that key in API Key Configuration and generate a replacement. Generating an additional key does not revoke existing keys automatically.