API Support: kokleong.l@affinidi.com
URL: https://affinidi.zendesk.com/hc/en-us/requests/new?ticket_form_id=360013052396
You can find out more about CommonCheck at https://www.commoncheck.org//
The CommonCheck QR Verifier is an API that allows customers to verify digital COVID-19 test, vaccination and recovery credentials both for authenticity, ownership and compliance with the destination’s entry requirements. By integrating this API into existing systems, airlines, governments and other organizations that need to verify COVID-19 credentials can automatically verify the health status of their travelers or customers. With the API, supported health certificates/documents can be checked for authenticity and evaluated against country-specific health-related entry requirements.
The Verifier API can also be used for non-travel use cases, for instance, for verifying the health certificates of a concert or sporting event attendees. It can also be used in domestic verification apps within a particular country. For domestic verification, the same endpoints can be invoked with a slight variation in the request body(more on this below).
The QR Verifier API takes in a QR content (the string that a QR code represents) and performs the following services:
Below is the list of issuers that the Verifier API supports
To get access to the API, you must have API keys provided by CommonCheck team. Please reach out using the form above if you require assistance.
This section covers the possible HTTP errors
This section covers the status codes that the Verifier API will respond
This section covers the full API request that should be used as payload.
We understand that there are many libraries and tools that can be used to read QR content. For the ease of your integration we have also included a QR code reader API to read and return the qrContent
The Api-Key must be provided in the request header for authorization.
The input file must be provided in the form-data and must be below 1 MB.
Accepted file types:
The output will be the QR content of the respective input file.
DISCLAIMER: THE COMMONS PROJECT FOUNDATION (“TCP”) DOES NOT PROVIDE MEDICAL ADVICE OR ADMINISTER ANY DIAGNOSTIC MEDICAL TESTS, VACCINES OR OTHER HEALTHCARE INTERVENTIONS. TCP MAKES NO ENDORSEMENT OR REPRESENTATION AS TO THE ACCREDITATION, LICENSING OR GOOD-STANDING OF ANY HEALTHCARE PROVIDER UNDER APPLICABLE STATE, FEDERAL, NATIONAL OR SUPRANATIONAL LAWS AND REGULATIONS. TCP EXPRESSLY DISCLAIMS ANY AND ALL LIABILITY FOR ANY CONSEQUENTIAL, INDIRECT, INCIDENTAL, SPECIAL OR EXEMPLARY DAMAGES, INCLUDING WITHOUT LIMITATION ANY LOSS OF REVENUES OR PROFITS OR ANY LOSS OF USE OF DATA, ARISING OUT OF OR CONNECTED IN ANY WAY WITH ANY DIAGNOSTIC TESTING, MEDICAL TREATMENT, VACCINATION OR OTHER HEALTHCARE INTERVENTION OR OTHERWISE PROVIDED, SPONSORED, OR PROMOTED BY ANY CTN MEMBER, WHETHER PROVIDED BY THE MEMBER ITSELF OR BY ITS AFFILIATES, REPRESENTATIVES, AGENTS OR SUBCONTRACTORS.
