Search…
Configuring certificates

Overview

This document will help an implementer configure a certificate (template and QR code) for a health event such as vaccination. This section includes configuring:

API

The DIVOC platform provides API services for generating digitally verifiable QR code-based vaccination certificates. The API for certificate generation has 6 sections:
  1. 1.
    PreEnrollmentCode: This section is linked to the “dose” in the vaccination section to uniquely identify the event. For example, beneficiary registration number (R101) and dose number (1) as (R101-1) will be used to identify the first dose event uniquely. Similarly, beneficiary registration number (R101) and dose number (2) as (R101-2) will be used to identify the second dose event uniquely.
  2. 2.
    Recipient: It contains information about the beneficiary.
  3. 3.
    Vaccination: It contains details about the vaccination event such as name, batch, and vaccination date.
  4. 4.
    Vaccinator: It contains details about the vaccinator.
  5. 5.
    Facility: It contains details about the facility where beneficiaries will get vaccinated.
  6. 6.
    Meta: It contains additional information, which is not part of the QR code, such as the number of past doses taken.

Sample for default certificate generation request

  • You can refer to the API service call with sample data below:
1
[
2
{
3
"preEnrollmentCode": "62",
4
"recipient": {
5
"name": "Sam",
6
"uhid": "abc2232",
7
"dob": "1990-09-14",
8
"age": "31",
9
"gender": "Male",
10
"nationality": "India",
11
"identity": "did:in.gov.uidai.aadhaar:11112222334",
12
"contact": [
13
"tel:1111111313"
14
],
15
"address": {
16
"addressLine1": "123, Koramangala",
17
"addressLine2": "",
18
"district": "Bengaluru South",
19
"state": "bihar",
20
"pincode": "560033"
21
}
22
},
23
"vaccination": {
24
"name": "covaxin",
25
"batch": "AB348FS",
26
"manufacturer": "Bharat Biotech",
27
"date": "2021-07-12T19:21:19.646Z",
28
"effectiveStart": "2021-07-12",
29
"effectiveUntil": "2021-08-12",
30
"dose": 2,
31
"totalDoses": 2
32
},
33
"vaccinator": {
34
"name": "Sooraj Singh"
35
},
36
"facility": {
37
"name": "ABCD Medical Center",
38
"address": {
39
"addressLine1": "123, Koramangala",
40
"addressLine2": "",
41
"district": "Bengaluru South",
42
"state": "Karnataka",
43
"pincode": "560033"
44
}
45
},
46
"programId": "6ce74c0f-b1b5-4b20-9fa2-084acbbd857a",
47
"meta": { //Meta section stored as an Object and it can contain information in Key value pair
48
}
49
}
50
]\
Copied!
  • Refer to the /v3/certify service here for details.
  • Click here if you want to understand the mandatory and non-mandatory information that should be there in a vaccination certificate, according to global standards.

Key Functionalities

  • Generate configured QR code
  • Generate configured certificate template

Prerequisite: Get details on API request and field validations

a. Please refer to the existing service details in the ‘certification’ section (/v3/certify): https://egovernments.github.io/DIVOC/developer-docs/api/admin-api.html#../../india/interfaces/vaccination-api.yaml
1
// /v3/certify:
2
post:
3
tags:
4
- certification
5
summary: Certify the one or more vaccination
6
description: >-
7
Certification happens asynchronously, this requires vaccinator
8
authorization and vaccinator should be trained for the vaccination that
9
is being certified. The payload for this API is compliant with DDCC core
10
data set prescribed by WHO
11
operationId: certifyV3
12
parameters:
13
- in: body
14
name: body
15
required: true
16
schema:
17
type: array
18
items:
19
$ref: '#/definitions/CertificationRequestV2' //Refer Line 722 in same file
20
responses:
21
'200':
22
description: OK
23
'400':
24
description: Invalid input
25
schema:
26
$ref: '#/definitions/Error'
Copied!

Making the changes

Click the following to see how you can make the changes:
All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.