Skip to content
CredTrail Docs Official credential APIs for higher education
Platform site

OB3 reference

TrustEd Credential Readiness

Author structured trust metadata on badge templates, evaluate readiness with an advisory checklist, and publish it on issued credentials.

Public verification Institution automation OB3 API
  • OAuth 2.0 with PKCE
  • OpenAPI schema
  • Credential and profile routes
Reference Key routes
GET

/discovery

Discovery document for standards-aware clients.

GET

/credentials

Credential read access for the authenticated subject.

PUT

/profile

Profile synchronization for issuer-managed records.

Service base URL https://credtrail.org/ims/ob/v3p0
Framework

1EdTech TrustEd Credential

CredTrail treats TrustEd Credential as a metadata quality framework built on Open Badges 3.0, not as a separate interoperability specification.

Authoring

Badge template checklist

Institution administrators add TrustEd metadata in the badge template editor and review an advisory readiness checklist before issuing.

Publication

Issued credential output

Saved metadata projects into the signed Open Badges 3.0 JSON-LD record and appears on public badge pages when structured trust fields are present.

What CredTrail means by TrustEd-ready

Section titled “What CredTrail means by TrustEd-ready”
Language

Use readiness language, not certification claims.

  • CredTrail supports TrustEd Credential readiness and metadata aligned with the 1EdTech TrustEd Credential Framework.
  • TrustEd-ready means required template metadata is present according to CredTrail’s checklist.
  • Do not describe CredTrail or issued credentials as TrustEd certified unless 1EdTech publishes and grants a certification path to CredTrail.

Readiness status describes badge template metadata completeness, not a public certification badge and not a guarantee that every possible TrustEd wire field is populated on every issued credential.

Where authoring happens

Section titled “Where authoring happens”
Template editor

TrustEd authoring checklist

Each badge template includes a TrustEd authoring checklist panel with metadata fields, a readiness summary, and a separate Save TrustEd metadata action.

Advisory only

Issuance is not blocked

The checklist helps registrars, faculty leads, and credential operations teams improve record quality. CredTrail does not prevent issuance when required checklist items are missing.

Not tenant automation

Separate from programmatic issue routes

TrustEd metadata is authored on badge templates in the institution admin UI. Tenant automation issue and revoke routes do not accept TrustEd fields directly.

Readiness status values

Section titled “Readiness status values”
not_evaluated
No valid TrustEd metadata is stored on the template yet.
incomplete
Metadata exists, but one or more required checklist expectations are missing.
ready
All required checklist expectations are satisfied. Recommended fields may still be missing.

Invalid stored metadata JSON is treated as not yet evaluated until an administrator repairs and re-saves the section.

Required checklist expectations

Section titled “Required checklist expectations”
Required

Missing any required item keeps the template in incomplete status.

  • Skills: at least one represented skill.
  • Framework alignment: at least one linked external framework alignment, preferably CASE, CTDL, or RSD.
  • Issuer authority: accreditation or awarding authority metadata for the issuing context.
  • Evidence: at least one evidence artifact.
  • Result: at least one result with a result date.
  • Criteria: criteria text or URI explaining what the learner needed to achieve.
  • Assessment: at least one assessment with description and date.
  • Achievement type: a specific value other than N/A or Not Applicable.
Section titled “Recommended checklist expectations”

Recommended fields are reported on the checklist but do not block ready status:

  • Rubric name or URI when applicable
  • Duration or credit information when applicable
  • Third-party endorsement name or URI when applicable

Authoring limitations in v1

Section titled “Authoring limitations in v1”

The template editor exposes one row per repeatable field (skills, alignments, evidence, results, assessments, rubrics, and endorsements). Saving writes at most one entry per array in the default authoring flow. Additional stored array entries are preserved when present, but multi-entry editing is not yet a first-class UI.

What recipients and verifiers see

Section titled “What recipients and verifiers see”

When an issued credential contains projected TrustEd metadata, the public badge page shows a Trust metadata section labeled TrustEd-aligned. That section summarizes structured fields such as skills, framework alignment, issuer authority, results, criteria, assessment, rubric, duration or credit, and endorsement data.

That public label means structured trust metadata is published in the credential. It is related to, but not identical with, the admin TrustEd-ready checklist status on the template.

For machine inspection, use the JSON-LD export on the same badge URL. Credentials with projected TrustEd fields include the CredTrail TrustEd context and remain signed with DataIntegrityProof using eddsa-rdfc-2022. See the public verification guide for route details.

Section titled “Related docs”
Public verification and downloadsReview the public badge page, Trust metadata section, verification JSON, and JSON-LD exports.Open Badges 3.0 APIReference the standards-based credential surface that carries projected TrustEd metadata.Institution automationIssue credentials programmatically after templates and TrustEd metadata are configured.