Prerequisites
- An Institution account on the Digital Certificate platform
- An API Secret key — generate one from your Institution profile. See Authentication for details.
curlor any HTTP client
Steps
Get your API Secret key
Log in to the Digital Certificate platform and navigate to your Institution profile. Generate an API Secret key. You will pass this key in the
X-DigiCert-Secret header of every request.The platform has two environments — use the sandbox base URL and a sandbox key while developing, then switch to production when you are ready to go live.| Environment | Base URL |
|---|---|
| Sandbox | https://api.sandbox.smartdocument.org/api/v1/external |
| Production | https://api.waec.org/api/v1/external |
Store your API Secret key securely — in an environment variable or secrets manager. Never hard-code it in your application or commit it to version control.
Confirm a certificate
Send a A successful response returns
POST request to /certificate/confirm with the candidate’s country, candidate number, and examination year. You can include multiple certificates in a single request.The example below uses the sandbox URL. Replace it with the production URL when you go live.200 OK with the confirmation results:The API always returns
200 OK even when a certificate is not found. Check each entry’s result field — a null value means no match was found for that candidate.Next steps
Certificates
Understand how confirmation records are structured and what data is returned.
Confirm guide
Detailed guide on confirming certificates in bulk and handling not-found results.
API reference
Full endpoint reference with every parameter, response schema, and example.