Details About QR code generation and vertification

[priyanka-TL]

For the project use case on Manage Learn side, we are planning to integrate Sunbird RC for certificate generate similar to the way its done in courses. Refere JIRA - https://project-sunbird.atlassian.net/browse/SB-28231

We have so far succeeded in generating a certificate based on our needs using Sunbird RC in local and
now we need some clarification on the how do we do it on the platform. If you can help us understand the below points:-

• Explanation on the fields under _osConfig
• How does QR code verification happen for courses? Which API of Sunbird RC is used?

Project Certificate Schema

{
	"$schema": "http://json-schema.org/draft-07/schema",
	"type": "object",
	"properties": {
		"ProjectCertificate": {
			"$ref": "#/definitions/ProjectCertificate"
		}
	},
	"required": [
		"ProjectCertificate"
	],
	"title": "ProjectCertificate",
	"definitions": {
		"ProjectCertificate": {
			"$id": "#/properties/ProjectCertificate",
			"type": "object",
			"title": "The ProjectCertificate Schema",
			"required": [
				"recipient",
				"projectName",
				"projectId"
			],
			"properties": {
				"status": {
					"type": "string",
					"enum": ["ACTIVE", "REVOKED", "DELETED"]
				},
				"recipient": {
					"$id": "#/properties/recipient",
					"$ref": "Recipient.json#/definitions/Recipient"
				},
				"templateUrl": {
					"type": "string"
				},
				"issuer": {
					"$id": "#/properties/issuer",
					"$ref": "Issuer.json#/definitions/Issuer"
				},
				"signatory": {
					"$id": "#/properties/signatory",
					"type": "array",
					"items": {
						"$ref": "Signatory.json#/definitions/Signatory"
					}
				},
				"projectName": {
					"type": "string"
				},
				"projectId": {
					"type": "string"
				},
				"solutionId": {
					"type": "string"
				},
				"solutionName": {
					"type": "string"
				},
				"programId": {
					"type": "string"
				},
				"programName": {
					"type": "string"
				}

			}
		}
	},
	"_osConfig": {
		"uniqueIndexFields": [],
		"ownershipAttributes": [],
		"roles": [],
		"inviteRoles": [
			"anonymous"
		],
		"systemFields": ["osCreatedAt", "osUpdatedAt", "osCreatedBy", "osUpdatedBy"],
		"enableLogin": false,
		"credentialTemplate": "https://gist.githubusercontent.com/priyanka-TL/5e2d9ad7611a348b5a3ebcc277884f4b/raw/80f582a3fc3fe6ee343a4a46bf0bc3bba3f7f66a/Final_project_credential_template.json"
	}
}

cc - @aks30 @vijiurs @kiranharidas187 @varsha-sl @Prateek-slokam @aishwaryashikshalokam

[priyanka-TL]

@tejash-jl any update on this query?

[priyanka-TL]

@tejash-jl can you please help on this query

[tejash-jl]

1. Explanation of the fields under _osConfig,
   This link will contain the schema config explanations, right now it's outdated. I'll rework on it.
   https://docs.sunbirdrc.dev/creating-your-own-schemas
2. How does QR code verification happen for courses? Which API of Sunbird RC is used?
   QR code verification can be done offline. Example code: https://github.com/tejash-jl/ref-sunbirdrc-certificate/tree/main/verification
   we also have api

curl --location --request POST '<host>/api/v1/verify' \
--header 'Content-Type: application/json' \
--data-raw '{"signedCredentials":{"@context":["https://www.w3.org/2018/credentials/v1","https://gist.githubusercontent.com/kesavanp123/88b70994bc2b88e3ab81eafbe755f28b/raw/7fe573bb1c5160917139fb03376f97ed6dbf752b/certificate-schema.json"],"type":["VerifiableCredential"],"issuanceDate":"2021-08-27T10:57:57.237Z","credentialSubject":{"type":"Person","name":"nishad"},"evidence":[{"type":["Certificate"],"certificateType":"Reputation","course":"Anguler","skill":"","awardedOn":"2022-06-05"}],"issuer":"did:issuer:sunbird","proof":{"type":"Ed25519Signature2018","created":"2022-05-09T06:12:01Z","verificationMethod":"did:india","proofPurpose":"assertionMethod","jws":"eyJhbGciOiJFZERTQSIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..GjI8H1HW0ekW8kMI0lsb6L-FspooIUuW_lF6Yob_QCND20wCr0wygqtqrxvvj0Zs52-Rb8KgE5-YKMgXOVn4AA"}}}'

[tejash-jl]

@priyanka-TL
you can find it here,
https://docs.sunbirdrc.dev/use/schema-configuration
https://docs.sunbirdrc.dev/creating-your-own-schemas

[priyanka-TL]

@tejash-jl I have created the certificate, but when scanning the certificate I'm not getting any link. Can you please help me to fix the issue? Please find the Schema below

ProjectCertificate

	"$schema": "http://json-schema.org/draft-07/schema",
	"type": "object",
	"properties": {
		"ProjectCertificate": {
			"$ref": "#/definitions/ProjectCertificate"
		}
	},
	"required": [
		"ProjectCertificate"
	],
	"title": "ProjectCertificate",
	"definitions": {
		"ProjectCertificate": {
			"$id": "#/properties/ProjectCertificate",
			"type": "object",
			"title": "The ProjectCertificate Schema",
			"required": [
				"recipient"
			],
			"properties": {
				"status": {
					"type": "string",
					"enum": ["ACTIVE", "REVOKED", "DELETED"]
				},
				"recipient":{
					"$id": "#/properties/recipient",
					"$ref": "Recipient.json#/definitions/Recipient"
				},
				"templateUrl": {
					"type": "string"
				},
				"issuer":{
					"$id": "#/properties/issuer",
					"$ref": "Issuer.json#/definitions/Issuer"
				},
				"signatory":{
					"$id": "#/properties/signatory",
					"type":"array",
					"items":{
						"$ref": "Signatory.json#/definitions/Signatory"
					}
				},
				"certificateLabel":{
					"type": "string"
				},
				"projectName":{
		           "type": "string"                
		        },
		        "projectId" : {
		        	"type": "string"
		        },
		        "solutionId" : {
		        	"type": "string"
		        },
		        "solutionName" : {
		        	"type": "string"
		        },
		        "programId" : {
		        	"type": "string"
		        },
		        "programName" : {
		        	"type": "string"
		        }

			}
		}
	},
	"_osConfig": {
		"uniqueIndexFields": [
		],
		"ownershipAttributes": [],
		"roles": [
		],
		"inviteRoles": [
			"anonymous"
		],
		"systemFields": ["osCreatedAt", "osUpdatedAt", "osCreatedBy", "osUpdatedBy"],
		"enableLogin": false,
		"credentialTemplate": "https://gist.githubusercontent.com/priyanka-TL/5e2d9ad7611a348b5a3ebcc277884f4b/raw/b3244502cda35fdf183b21f8abe2692524c5b413/Final_project_credential_template.json"
	}
}

Generated Certificate
latest_project_cert.pdf

Template URL
https://gist.githubusercontent.com/priyanka-TL/56e5e4a65d672a15c13dca9f51614cc2/raw/0c4cdbc83d62b16abef1b692610d27ab881a9789/oneLogoTwoSignatory.svg

[priyanka-TL]

@tejash-jl Can you please help us to figure out the issue

[tejash-jl]

@priyanka-TL the current QR code in the certificate contains the actual VC and not the link. If you need the link then you need to set the QR_TYPE env for the certificate-api service. You will also need to set the certDomainUrl env for the baseUrl of the link.

[tejash-jl]

@priyanka-TL You need to set QR_TYPE =URL_W3C_VC