Skip to content

Add OBv3 'identifier' property. #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dmitrizagidulin merged 1 commit into from
Oct 15, 2025
Merged

Add OBv3 'identifier' property. #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ssi Changelog

## 5.2.0 -
### Added
- Add `identifier` property to `IOpenBadgeSubject` export.

## 5.1.0 - 2025-10-10
### Added
- Export `IOpenBadgeCredentialV3` interface.
Expand Down
11 changes: 10 additions & 1 deletion src/OBv3.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,29 @@ import { IVerifiableCredential } from './VCDM.js'
import { ILdType, ILinkedDataObject } from './LD.js'

/**
* OBv3 Credential (Assertion)
* OBv3 Credential
* Extends W3C VC with an OBv3-specific credentialSubject
*/
export interface IOpenBadgeCredentialV3 extends IVerifiableCredential {
credentialSubject: IOpenBadgeSubject | IOpenBadgeSubject[]
}

export interface IOBv3IdentityObject {
hashed: boolean
// @see https://www.imsglobal.org/spec/ob/v3p0/#org.1edtech.ob.v3p0.identifiertypeenum.class
identityType?: string | string[]
identityHash?: string
salt?: string
}

/**
* OBv3 CredentialSubject
* https://www.imsglobal.org/spec/ob/v3p0/#credentialsubject
*/
export interface IOpenBadgeSubject extends ILinkedDataObject {
achievement: IAchievement | string
evidence?: IOBv3Evidence | IOBv3Evidence[]
identifier?: IOBv3IdentityObject | IOBv3IdentityObject[]
[x: string]: any
}

Expand Down