Skip to main content

Mapping POK credential fields to OpenBadge 3.0 and 2.0

When you complete a credential design in POK Proof of Knowledge, every field you fill in becomes part of a JSON file that complies with the OpenBadge 3.0 and OpenBadge 2.0 standards. This reference shows how each POK field maps to the technical properties of both models, so you can validate the full structure of your credentials.

Where to complete these fields​

Fill in these fields from the Template editor under "My Designs" while creating the credential design you plan to issue.

  1. While editing the template, click the shortcut "How to improve the quality of my Open Badge 3.0".

  2. Enable the toggle "I want this credential to comply with Open Badge quality standards".

Field mappings​

1. Achievement Earned​

By default, POK uses the credential design's "Title" attribute. You can replace this value with any attribute created within the design, or define a new default value.

  • OpenBadge 3.0: Achievement.name
  • OpenBadge 2.0: BadgeClass.name

2. Description​

This text appears as the credential description on the recipient's credential page.

  • OpenBadge 3.0: Achievement.description
  • OpenBadge 2.0: BadgeClass.description

3. Earning Criteria​

This text appears as the credential requirements on the recipient's credential page.

  • OpenBadge 3.0: Achievement.criteria.narrative
  • OpenBadge 2.0: BadgeClass.criteria.narrative

4. Evidence​

  • ID
    • OB 3.0: AchievementCredential.evidence.id
    • OB 2.0: Assertion.Evidence.id
  • Evidence Name
    • OB 3.0: AchievementCredential.evidence.name
    • OB 2.0: Assertion.Evidence.name
  • Evidence Description
    • OB 3.0: AchievementCredential.evidence.description
    • OB 2.0: Assertion.Evidence.description
  • Narrative
    • OB 3.0: AchievementCredential.evidence.narrative
    • OB 2.0: Assertion.Evidence.narrative

5. Credits Earned​

  • OB 3.0: AchievementSubject.creditsEarned
  • OB 2.0: BadgeClass.creditsEarned

6. External Endorsements​

  • OB 3.0: AchievementSubject.externalEndorsements
  • OB 2.0: BadgeClass.externalEndorsements

7. Internal Tags​

  • OB 3.0: Achievement.tag
  • OB 2.0: BadgeClass.tags

8. Alignment​

  • Reference Framework
    • OB 3.0: Achievement.alignment.targetFramework
    • OB 2.0: BadgeClass.Alignment.targetFramework
  • Name
    • OB 3.0: Achievement.alignment.targetName
    • OB 2.0: BadgeClass.Alignment.targetName
  • Framework Description
    • OB 3.0: Achievement.alignment.targetDescription
    • OB 2.0: BadgeClass.Alignment.targetDescription
  • URL
    • OB 3.0: Achievement.alignment.targetUrl
    • OB 2.0: BadgeClass.Alignment.targetUrl

9. Issuer Information​

  • Name
    • OB 3.0: AchievementCredential.issuer.name
    • OB 2.0: Issuer.Profile.name
  • Issuer Description
    • OB 3.0: AchievementCredential.issuer.description
    • OB 2.0: Issuer.Profile.description
  • Address
    • OB 3.0: AchievementCredential.issuer.address
  • URL
    • OB 3.0: AchievementCredential.issuer.url
    • OB 2.0: Issuer.Profile.url
  • Contact
    • OB 3.0: AchievementCredential.issuer.email
    • OB 2.0: Issuer.Profile.email

10. "Version" Attribute​

During issuance, POK adds the "Version" field to complete the required information. It indicates the version of the credential cohort being issued.

  • OB 3.0: Achievement.version
  • OB 2.0: BadgeClass.version

What is this mapping used for?​

  • It ensures every piece of information you enter is correctly linked to the corresponding property in the standard.
  • It guarantees compatibility with systems that validate OpenBadge 2.0 and 3.0 credentials.
  • It makes it easier to review and validate the JSON that POK generates automatically.

Validating the issued JSON​

To validate or inspect the issued JSON, you can use external validators compatible with the IMS Global (1EdTech) standards:

Questions?​

If you have any questions or run into issues, contact us at contact@pok.tech.