This article gives an overview of the IVQA API, how to get an API token, and what the API can do.

Introduction#

The IVQA API lets your own systems create verifications, get QR Codes and read verification status. It is the same API used by the Google Workspace and Microsoft Office add-ons. Requests are sent to https://api.ivqa.org/api/ext with an API token.

A. Get an API token#

  • Log in to your dashboard as Owner or Admin

  • Go to Settings > API Tokens

  • Click Create API token

  • Enter a name, tick the scopes the integration needs, and choose an expiration

  • Copy the token now. It is shown only once

[SCREENSHOT REQUIRED]

Settings → API Tokens

The API Tokens tab of Settings

expected file: public/images/api/api-tokens.png

The list shows each token with its prefix, scopes, last use and expiry. Click Revoke to disable a token.

B. Send the token#

  • Add the header Authorization: Bearer <token> to every request

  • Call GET /api/ext/ping to check that the token works

C. Scopes#

  • credentials:read: dashboard, statistics, activity, documents, students, employees, search, verification status

  • verify:read: QR Code generation

  • verify:write: create verifications, issue student and employee documents

D. Main endpoints#

  • POST /student-documents and POST /employee-documents: issue a document from a template. Each call creates a new document with a new QR Code

  • POST /verification: create a verification for an external editor document

  • GET /qr: the QR Code image of a verification

  • GET /verification/status?public_id=…: the status and scan counts of a verification

  • GET /students, GET /employees, GET /documents, GET /search: read your data

Note: The limit is 120 requests per 10 minutes per token. Errors are returned as { "ok": false, "error": "…", "code": "…" }. IVQA does not send webhooks; poll the status endpoint instead.

For the full contract, contact the IVQA team.

If you have any questions, you can see more topics in this knowledge base or reach out to the IVQA team at support@ivqa.tech.