Adding APIs for downloading a digital credential #3149

annagav · 2025-12-16T01:50:55Z

What are the relevant tickets?

Related to https://github.com/mitodl/hq/issues/9622

Description (What does it do?)

Api to download the verifiable credential

How can this be tested?

Nothing should break.

Update VERIFIABLE_CREDENTIAL_SIGNER_URL from VC_SIGNER_URL

If you have already created a VerifiableCredentail then you can go ahead and try downloading it:

curl -X GET "http://mitxonline.odl.local:9080/api/v2/verifiable_course_credential/<credential_id>/download/"

Returns
{"id": "urn:uuid:cc7dfe00-44b4-4ff2-9369-5cf3fbd74cf6", "type": ["VerifiableCredential", "OpenBadgeCredential"], "proof": {"type": "Ed25519Signature2020", "created": "2025-12-17T19:38:16Z", "proofValue": "z3hP9Mctg5rJHqVNoLajo1czjZFrQ2qcTnXi3EEKJxycifhJ3QS3FdtyurxEtBD7jkQSNW73vH9bfyomJNDE55nUW", "proofPurpose": "assertionMethod", "verificationMethod": "did:key:z6MknNQD1WHLGGraFi6zcbGevuAgkVfdyCdtZnQTGWVVvR5Q#z6MknNQD1WHLGGraFi6zcbGevuAgkVfdyCdtZnQTGWVVvR5Q"}, "issuer": {"id": "did:key:z6MknNQD1WHLGGraFi6zcbGevuAgkVfdyCdtZnQTGWVVvR5Q", "name": "MIT Learn", "type": ["Profile"], "image": {"id": "https://github.com/digitalcredentials/test-files/assets/206059/01eca9f5-a508-40ac-9dd5-c12d11308894", "type": "Image", "caption": "MIT Learn logo"}}, "@context": ["https://www.w3.org/ns/credentials/v2", "https://purl.imsglobal.org/spec/ob/v3p0/context-3.0.3.json", "https://w3id.org/security/suites/ed25519-2020/v1"], "validFrom": "2025-12-17T19:38:16Z", "validUntil": "2030-01-01T00:00:00Z", "credentialSubject": {"type": ["AchievementSubject"], "identifier": [{"salt": "not-used", "type": "IdentityObject", "hashed": false, "identityHash": "Anna Gavrilman", "identityType": "name"}], "achievement": {"id": "urn:uuid:cc7dfe00-44b4-4ff2-9369-5cf3fbd74cf6", "name": "Case 10: Run Archived Enrollable, Future Enrollment Open", "type": ["Achievement"], "image": {"id": "https://github.com/digitalcredentials/test-files/assets/206059/01eca9f5-a508-40ac-9dd5-c12d11308894", "type": "Image", "caption": "MIT Learn Certificate logo"}, "criteria": {"narrative": "If you wanted to add some kind of criteria, e.g. a list of courses or modules, etc. CAN BE MARKDOWN"}, "description": "Anna Gavrilman has successfully completed all modules and earned a Course Certificate in Case 10: Run Archived Enrollable, Future Enrollment Open.", "achievementType": "Course"}, "activityEndDate": "2025-02-24T00:00:00Z", "activityStartDate": "2023-03-01T00:00:00Z"}}%

github-actions · 2025-12-16T01:51:12Z

OpenAPI Changes

Show/hide ## Changes for v0.yaml:

## Changes for v0.yaml:
2 changes: 0 error, 0 warning, 2 info
info	[endpoint-added] at head/openapi/specs/v0.yaml	
	in API GET /api/v2/verifiable_course_credential/{credential_id}/download/
		endpoint added

info	[endpoint-added] at head/openapi/specs/v0.yaml	
	in API GET /api/v2/verifiable_program_credential/{credential_id}/download/
		endpoint added



## Changes for v1.yaml:
2 changes: 0 error, 0 warning, 2 info
info	[endpoint-added] at head/openapi/specs/v1.yaml	
	in API GET /api/v2/verifiable_course_credential/{credential_id}/download/
		endpoint added

info	[endpoint-added] at head/openapi/specs/v1.yaml	
	in API GET /api/v2/verifiable_program_credential/{credential_id}/download/
		endpoint added



## Changes for v2.yaml:
2 changes: 0 error, 0 warning, 2 info
info	[endpoint-added] at head/openapi/specs/v2.yaml	
	in API GET /api/v2/verifiable_course_credential/{credential_id}/download/
		endpoint added

info	[endpoint-added] at head/openapi/specs/v2.yaml	
	in API GET /api/v2/verifiable_program_credential/{credential_id}/download/
		endpoint added

Unexpected changes? Ensure your branch is up-to-date with main (consider rebasing).

digital_credential/views.py

for more information, see https://pre-commit.ci

dsubak

Looks pretty good - I'll give it a quick test after standup, but this seems straightforward to me!

I had a few minor bits of feedback, but I'll approve it up front and you can take or leave any of my comments at your discretion!

dsubak · 2025-12-18T14:00:42Z

courses/views/v2/__init__.py

+
+
+@extend_schema(
+    description="Returns the json for the verifiable credential with the given ID, if it belongs to the user.",


I think right now this allows unauthenticated access, should we change the description?

Suggested change

description="Returns the json for the verifiable credential with the given ID, if it belongs to the user.",

description="Returns the json for the verifiable credential with the given ID.",

dsubak · 2025-12-18T14:04:22Z

courses/views/v2/__init__.py

+    credential = get_object_or_404(
+        VerifiableCredential,
+        pk=credential_id,
+    )


It might be worth a comment that right now the Certificate and Credential UUID are the same (and it seems like that'll be the case, at least for the immediate future) which is why we can pipe it directly in as the primary key.

dsubak · 2025-12-18T14:07:24Z

courses/utils.py

+def dc_url(path):
+    """Returns the full url to the provided path"""
+    return urljoin(settings.DIGITAL_CREDENTIAL_ISSUER_URL, path)


I don't think we've got DIGITAL_CREDENTIAL_ISSUER_URL - we might be able to remove this for now?

Alternatively, we could use VERIFIABLE_CREDENTIAL_SIGNER_URL, keep the utility function and I'll rework the task hooks to use it - dealer's choice!

I mean removed for now

dsubak · 2025-12-18T14:09:39Z

main/settings.py


-VC_SIGNER_URL = get_string(
-    name="VC_SIGNER_URL",
+VERIFIABLE_CREDENTIAL_SIGNER_URL = get_string(


We'll need to change this over in api.request_verifiable_credential to match this new name, and in the env.example file too. I'm happy to do that in a follow on PR if you'd like!

dsubak · 2025-12-18T14:47:30Z

Just tested it, works great!

for more information, see https://pre-commit.ci

github-advanced-security bot found potential problems Dec 16, 2025

View reviewed changes

digital_credential/views.py Fixed Show fixed Hide fixed

digital_credential/views.py Fixed Show fixed Hide fixed

digital_credential/views.py Fixed Show fixed Hide fixed

annagav force-pushed the ag/add_dc_api branch from 86bcd76 to d9a5e35 Compare December 16, 2025 13:50

github-advanced-security bot found potential problems Dec 16, 2025

View reviewed changes

digital_credential/views.py Fixed Show fixed Hide fixed

digital_credential/views.py Fixed Show fixed Hide fixed

annagav force-pushed the ag/add_dc_api branch 2 times, most recently from dfcc33d to 3071ef6 Compare December 16, 2025 14:43

annagav marked this pull request as ready for review December 16, 2025 17:18

annagav force-pushed the ag/add_dc_api branch from fc90b18 to 5d0286f Compare December 17, 2025 16:24

annagav and others added 10 commits December 17, 2025 15:17

Adding APIs for verifying, revoking a digital credentail

003ce5d

revoke and verify

9c84b2d

url

4f0e02b

payload

d72d355

[pre-commit.ci] auto fixes from pre-commit.com hooks

cb4f047

for more information, see https://pre-commit.ci

refining

162b63a

Downlload certificate

2fb445a

remove

6fe040a

const

f7ab84d

[pre-commit.ci] auto fixes from pre-commit.com hooks

3c34633

for more information, see https://pre-commit.ci

annagav force-pushed the ag/add_dc_api branch from 7e850e1 to 3c34633 Compare December 17, 2025 20:27

annagav added 2 commits December 17, 2025 15:40

update names

cbe397d

download

db74b7a

annagav force-pushed the ag/add_dc_api branch from 9caf68f to db74b7a Compare December 17, 2025 21:05

annagav changed the title ~~Adding APIs for verifying, revoking a digital credential~~ Adding APIs for downloading a digital credential Dec 17, 2025

annagav added 2 commits December 17, 2025 16:23

permissions

59183f8

import

d43f9a9

annagav force-pushed the ag/add_dc_api branch from 28714d5 to d43f9a9 Compare December 17, 2025 21:24

openapi

a9191d1

annagav force-pushed the ag/add_dc_api branch from 9d2bb02 to a9191d1 Compare December 17, 2025 21:32

annagav added the Needs Review label Dec 17, 2025

fix

72a362e

annagav force-pushed the ag/add_dc_api branch from 4ee4eb1 to 72a362e Compare December 17, 2025 21:53

update

dcac06f

annagav force-pushed the ag/add_dc_api branch from b1a74b9 to dcac06f Compare December 18, 2025 13:42

annagav requested review from dsubak and jkachel December 18, 2025 13:57

dsubak approved these changes Dec 18, 2025

View reviewed changes

address comments

d914e44

annagav force-pushed the ag/add_dc_api branch from 8b12ce2 to d914e44 Compare December 18, 2025 14:54

pre-commit-ci bot and others added 2 commits December 18, 2025 14:54

[pre-commit.ci] auto fixes from pre-commit.com hooks

9fb436d

for more information, see https://pre-commit.ci

spec

a8c151d

annagav merged commit d8b0a88 into main Dec 18, 2025
9 checks passed

annagav deleted the ag/add_dc_api branch December 18, 2025 15:48

This was referenced Dec 18, 2025

Release 0.136.5 #3156

Closed

Release 0.137.0 #3165

Open



		@extend_schema(
		description="Returns the json for the verifiable credential with the given ID, if it belongs to the user.",

Adding APIs for downloading a digital credential #3149

Adding APIs for downloading a digital credential #3149

Uh oh!

Conversation

annagav commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What are the relevant tickets?

Description (What does it do?)

How can this be tested?

Uh oh!

github-actions bot commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

OpenAPI Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dsubak left a comment

Choose a reason for hiding this comment

Uh oh!

dsubak Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

dsubak Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

dsubak Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

annagav Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

annagav Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

dsubak Dec 18, 2025

Choose a reason for hiding this comment

Uh oh!

dsubak commented Dec 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

annagav commented Dec 16, 2025 •

edited

Loading

github-actions bot commented Dec 16, 2025 •

edited

Loading