Skip to content

OBI Methods

Badge Terminology Clarification

Within Acclaim, we've been referring to individual badges and the specifications for those badges with slightly different terminology than the OBI uses:

Acclaim OBI
Badge BadgeAssertion
BadgeTemplate BadgeClass

For the OBI-compliant parts of the API, we'll use the OBI's language to minimize confusion.

You can read more about OBI hosted assertions here.

Get Badge Assertion

Request

GET /obi/badge_assertions/<badge_id>

Response

200 OK

{
  "@context": "https://w3id.org/openbadges/v1",
  "type": "Assertion",
  "id": "https://api.youracclaim.com/v1/obi/badge_assertions/dce23d32-eb2d-49ae-b068-11aecf5ec2ec",
  "uid": "dce23d32-eb2d-49ae-b068-11aecf5ec2ec",
  "recipient": {
    "type": "email",
    "identity": "sha256$b36a83701f1c3191e19722d6f90274bc1b5501fe69ebf33313e440fe4b0fe210",
    "hashed": true
  },
  "image": "https://cdn.example.com/path/to/image.png",
  "evidence": "https://www.youracclaim.com/badges/dce23d32-eb2d-49ae-b068-11aecf5ec2ec",
  "issuedOn": "2014-04-01T14:41:00.000Z",
  "badge": "https://api.youracclaim.com/v1/obi/badge_classes/670dcefd-e914-4707-9691-80496ee60360",
  "verify": {
    "type": "hosted",
    "url": "https://api.youracclaim.com/v1/obi/badge_assertions/dce23d32-eb2d-49ae-b068-11aecf5ec2ec"
  },
  "expires": "2018-04-22T17:15:37.983Z"
}

Get Badge Class

Request

GET /obi/badge_classes/<badge_class_id>

Response

200 OK

{
  "@context": "https://w3id.org/openbadges/v1",
  "type": "BadgeClass",
  "id": "https://api.youracclaim.com/v1/obi/badge_classes/75531f61-5cf8-4a8c-aff1-03d4e35361ab",
  "name": "Badge Template 2",
  "description": "Dynamically deliver go forward e-tailers",
  "image": "https://cdn.example.com/path/to/image.png",
  "criteria": "https://www.youracclaim.com/badge_templates/96804a7d-c070-4ea9-90cb-efa21aa58104",
  "issuer": "https://api.youracclaim.com/v1/obi/issuers/12b808a7-249d-42fe-a63d-30ffba7bb1fb",
  "alignment": [
    {
      "name": "Alignment 2",
      "url": "http://www.example.com/alignment",
      "description": "Self-enabling cohesive task-force"
    }
  ],
  "tags": [
    "Skill 621"
  ]
}

Get Issuer

Request

GET /obi/issuers/<issuer_id>

Response

200 OK

{
  "@context": "https://w3id.org/openbadges/v1",
  "type": "IssuerOrg",
  "id": "https://api.youracclaim.com/v1/obi/issuers/2eea3b23-ae26-4eb3-b639-dea745133480",
  "name": "Organization 787",
  "url": "http://www.example.com/",
  "description": "Function-based eco-centric standardization gurus",
  "image": "https://cdn.example.com/path/to/image.png",
  "email": "hello788@example.com"
}