> For the complete documentation index, see [llms.txt](https://divoc.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://divoc.digit.org/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates.md). # 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: * [Generating signed key pairs](/platform/configuration/configuring-the-certification-and-verification-component/generating-signed-key-pairs.md) * [Certificate generation request](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-1-create-a-certification-generation-request.md) * [QR code section](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-2-configure-the-qr-code-content.md) * [Certificate template](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-3-configure-the-certificate-template.md) ## 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. **PreEnrollmentCode:** This section is linked to the 'dose' in the vaccination section to uniquely identify an 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. **Recipient:** It contains information about the beneficiary. 3. **Vaccination:** It contains details about the vaccination event such as name, batch, and vaccination date. 4. **Vaccinator:** It contains details about the vaccinator. 5. **Facility:** It contains details about the facility where beneficiaries will get vaccinated. 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: ``` [ { "preEnrollmentCode": "62", "recipient": { "name": "Sam", "uhid": "abc2232", "dob": "1990-09-14", "age": "31", "gender": "Male", "nationality": "India", "identity": "did:in.gov.uidai.aadhaar:11112222334", "contact": [ "tel:1111111313" ], "address": { "addressLine1": "123, Koramangala", "addressLine2": "", "district": "Bengaluru South", "state": "bihar", "pincode": "560033" } }, "vaccination": { "name": "covaxin", "batch": "AB348FS", "manufacturer": "Bharat Biotech", "date": "2021-07-12T19:21:19.646Z", "effectiveStart": "2021-07-12", "effectiveUntil": "2021-08-12", "dose": 2, "totalDoses": 2 }, "vaccinator": { "name": "Sooraj Singh" }, "facility": { "name": "ABCD Medical Center", "address": { "addressLine1": "123, Koramangala", "addressLine2": "", "district": "Bengaluru South", "state": "Karnataka", "pincode": "560033" } }, "programId": "6ce74c0f-b1b5-4b20-9fa2-084acbbd857a", "meta": { //Meta section stored as an Object and it can contain information in Key value pair } } ]\ ``` * Refer to the /v3/certify service [**here**](https://raw.githubusercontent.com/egovernments/DIVOC/main/interfaces/../../india/interfaces/vaccination-api.yaml) for details. * Click [**here**](/platform/divocs-verifiable-certificate-features-2.0/what-information-goes-into-a-qr-code.md) 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**](https://egovernments.github.io/DIVOC/developer-docs/api/admin-api.html#../../india/interfaces/vaccination-api.yaml) b. The detailed field validations are mentioned here: [**https://github.com/egovernments/DIVOC/blob/4076e69cf152fd76dafa8a0565777895f55b1245/interfaces/vaccination-api.yaml**](https://github.com/egovernments/DIVOC/blob/4076e69cf152fd76dafa8a0565777895f55b1245/interfaces/vaccination-api.yaml) ``` // /v3/certify: post: tags: - certification summary: Certify the one or more vaccination description: >- Certification happens asynchronously, this requires vaccinator authorization and vaccinator should be trained for the vaccination that is being certified. The payload for this API is compliant with DDCC core data set prescribed by WHO operationId: certifyV3 parameters: - in: body name: body required: true schema: type: array items: $ref: '#/definitions/CertificationRequestV2' //Refer Line 722 in same file responses: '200': description: OK '400': description: Invalid input schema: $ref: '#/definitions/Error' ``` ## Making the changes Click the following to see how you can make the changes: 1. [**Create a certification generation request**](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-1-create-a-certification-generation-request.md) 2. [**Update the QR code content**](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-2-configure-the-qr-code-content.md) 3. [**Update the certificate template**](/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates/step-3-configure-the-certificate-template.md) [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.* --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://divoc.digit.org/platform/configuration/configuring-the-certification-and-verification-component/configuring-certificates.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.