Ctrlk
Community
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Badgeclasses

Get a list of BadgeClasses for authenticated user

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Query parameters
include_archivedbooleanOptionalDefault: false
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/badgeclasses
GET /v2/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Create a new BadgeClass

post
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Body
achievementTypestring · nullableOptional

The type of achievement

Example: Course
criteriaNarrativestring · nullableOptional

Markdown formatted description of the criteria

criteriaUrlstring · uri · nullableOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria
descriptionstring · max: 16384 · nullableRequired

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.
imagestring · nullableRequired

Image of the badge class as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==
imageAltTextstring · nullableOptional
issuerstring · nullableRequired

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q
namestring · max: 1024 · nullableRequired

Name of the BadgeClass

Example: Math Expert
tagsstring[] · nullableOptional

List of tags that describe the BadgeClass

Responses
201

BadgeClass created

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/badgeclasses
POST /v2/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1087

{
  "achievementType": "Course",
  "alignments": [
    {
      "displayAsSkill": true,
      "targetCode": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetName": "text",
      "targetUrl": "text"
    }
  ],
  "criteriaNarrative": "text",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "imageAltText": "text",
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "customPropertyValues": [
      {
        "arrayValue": [
          "text"
        ],
        "doubleValue": 1,
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "public": true,
        "stringValue": "text"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "tags": [
    "text"
  ]
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Reactivate a BadgeClass by ref

post

Reactivate an archived BadgeClass by its base64 encoded OpenBadge ID

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
refstringRequired
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/badgeclasses/reactivate/ref/{ref}
POST /v2/badgeclasses/reactivate/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Reactivate a BadgeClass by id

post

Reactivate a BadgeClass that was archived

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/badgeclasses/reactivate/{idOrEntityId}
POST /v2/badgeclasses/reactivate/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete a BadgeClass

delete

Restricted to owners or editors (not staff) of the corresponding Issuer.

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
refstringRequired
Query parameters
hard_deletestringOptional
archivalNotestringOptional
Responses
204

BadgeClass deleted

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
delete/v2/badgeclasses/ref/{ref}
DELETE /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a single BadgeClass

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
refstringRequired
Query parameters
include_archivedbooleanOptionalDefault: false
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/badgeclasses/ref/{ref}
GET /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update an existing BadgeClass.

put

Previously awarded Assertions will be updated with image rebaking

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
refstringRequired
Body
achievementTypestringOptional

The type of achievement

Example: Course
criteriaNarrativestringOptional

Markdown formatted description of the criteria

criteriaUrlstring · uriOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria
descriptionstring · max: 16384 · nullableRequired

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.
imagestringRequired

Image of the badge class as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==
imageAltTextstringOptional
namestring · max: 1024 · nullableRequired

Name of the BadgeClass

Example: Math Expert
tagsstring[]Optional

List of tags that describe the BadgeClass

Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
put/v2/badgeclasses/ref/{ref}
PUT /v2/badgeclasses/ref/{ref} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1051

{
  "achievementType": "Course",
  "alignments": [
    {
      "displayAsSkill": true,
      "targetCode": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetName": "text",
      "targetUrl": "text"
    }
  ],
  "criteriaNarrative": "text",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "imageAltText": "text",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "customPropertyValues": [
      {
        "arrayValue": [
          "text"
        ],
        "doubleValue": 1,
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "public": true,
        "stringValue": "text"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "tags": [
    "text"
  ]
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Delete a BadgeClass

delete

Restricted to owners or editors (not staff) of the corresponding Issuer.

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Query parameters
hard_deletestringOptional
archivalNotestringOptional
Responses
204

BadgeClass deleted

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
delete/v2/badgeclasses/{idOrEntityId}
DELETE /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a single BadgeClass

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Query parameters
include_archivedbooleanOptionalDefault: false
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/badgeclasses/{idOrEntityId}
GET /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update an existing BadgeClass.

put

Previously awarded Assertions will be updated with image rebaking

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Body
achievementTypestringOptional

The type of achievement

Example: Course
criteriaNarrativestringOptional

Markdown formatted description of the criteria

criteriaUrlstring · uriOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria
descriptionstring · max: 16384 · nullableRequired

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.
imagestringRequired

Image of the badge class as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==
imageAltTextstringOptional
namestring · max: 1024 · nullableRequired

Name of the BadgeClass

Example: Math Expert
tagsstring[]Optional

List of tags that describe the BadgeClass

Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
put/v2/badgeclasses/{idOrEntityId}
PUT /v2/badgeclasses/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1051

{
  "achievementType": "Course",
  "alignments": [
    {
      "displayAsSkill": true,
      "targetCode": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetName": "text",
      "targetUrl": "text"
    }
  ],
  "criteriaNarrative": "text",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "imageAltText": "text",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "customPropertyValues": [
      {
        "arrayValue": [
          "text"
        ],
        "doubleValue": 1,
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "public": true,
        "stringValue": "text"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "tags": [
    "text"
  ]
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get a list of ClaimCodes for a single BadgeClass

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Query parameters
includeClaimCodeCountbooleanOptional
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/badgeclasses/{idOrEntityId}/claim-codes
GET /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "claimCount": 1,
      "claimUrl": "text",
      "code": "5678945",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "enabled": true,
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Create a new ClaimCode for a BadgeClass

post
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Body
expirationDatestring · date-time · nullableOptional
labelstring · nullableOptional

The label of the claim code

Example: Conference Event
limitinteger · int64 · nullableOptional

The number of times the claim code can be used

Example: 10
Responses
201

Created

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/badgeclasses/{idOrEntityId}/claim-codes
POST /v2/badgeclasses/{idOrEntityId}/claim-codes HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "label": "Conference Event",
  "limit": 10
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "claimCount": 1,
      "claimUrl": "text",
      "code": "5678945",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "enabled": true,
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Archive a ClaimCode for a BadgeClass

delete
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
204

No Content

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
delete/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}
DELETE /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Update an existing ClaimCode for a BadgeClass

put
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Body
expirationDatestring · date-time · nullableOptional
labelstring · nullableOptional

The label of the claim code

Example: Conference Event
limitinteger · int64 · nullableOptional

The number of times the claim code can be used

Example: 10
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
put/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}
PUT /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 83

{
  "expirationDate": "2026-01-01T00:00:00.000Z",
  "label": "Conference Event",
  "limit": 10
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "claimCount": 1,
      "claimUrl": "text",
      "code": "5678945",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "enabled": true,
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Disable an enabled ClaimCode for a BadgeClass

patch
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
patch/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/disable
PATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/disable HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "claimCount": 1,
      "claimUrl": "text",
      "code": "5678945",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "enabled": true,
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Enable a disabled ClaimCode for a BadgeClass

patch
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
claimCodestringRequired
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
patch/v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/enable
PATCH /v2/badgeclasses/{idOrEntityId}/claim-codes/{claimCode}/enable HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "claimCount": 1,
      "claimUrl": "text",
      "code": "5678945",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "enabled": true,
      "expirationDate": "2026-01-01T00:00:00.000Z",
      "label": "Conference Event",
      "limit": 10
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Duplicate a BadgeClass

post

Create a duplicate of the original BadgeClass with a new name

Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Body
newNamestringRequired

The new name for the duplicate badgeclass

Example: Badgeclass Copy
Responses
201

BadgeClass created

achievementTypestring · nullableOptional

The type of achievement

Example: Course
archivalNotestring · nullableOptional
archivedboolean · nullableOptional
archivedDatestring · date-time · nullableOptional
createdAtstring · date-time · nullableOptional

Timestamp when the BadgeClass was created

createdBystring · nullableOptional

Entity ID of the user who created this BadgeClass

Example: Hey7J-GRSJeu6FNnHQwNyw
criteriaNarrativestring · nullableOptional

Markdown formatted description of the criteria

criteriaUrlstring · uri · nullableOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria
descriptionstringRequired

Short description of the badge class

Example: This badge is awarded to students who have demonstrated mastery of Math.
entityIdstringRequired

Unique identifier for this BadgeClass

Example: iOMWsaF1QbmMCofM54JlUg
entityTypestringRequiredExample: BadgeClass
idstringRequired

Internal ID for this BadgeClass

Example: 68e9d238c5afe622816febb3
imagestringRequired

Image of the badge class. Most commonly an URL.

Example: https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image
imageAltTextstring · nullableOptional
imagePathstring · nullableOptional

Internal image path

Example: uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png
issuerstringRequired

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q
issuerOpenBadgeIdstring · uriRequired

OB URL of the issuer

Example: https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A
namestringRequired

Name of the badge class

Example: Math Expert
openBadgeIdstring · uriRequired

URL of the OpenBadge compliant json

Example: https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg
originalJsonstring · nullableOptional

The original OB JSON if the badge class was exported

Example: {}
sourcestring · nullableOptional

The original source of the BadgeClass

Example: local
sourceUrlstring · nullableOptional

The original URL of the BadgeClass if it was imported

Example: https://example.com/badge-classes/1
tagsstring[]Required

List of tags that describe the BadgeClass

post/v2/badgeclasses/{idOrEntityId}/duplicate
POST /v2/badgeclasses/{idOrEntityId}/duplicate HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "newName": "Badgeclass Copy"
}
{
  "achievementType": "Course",
  "alignments": [
    {
      "displayAsSkill": true,
      "targetCode": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetName": "text",
      "targetUrl": "text"
    }
  ],
  "archivalNote": "text",
  "archived": true,
  "archivedDate": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
  "criteriaNarrative": "text",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "entityId": "iOMWsaF1QbmMCofM54JlUg",
  "entityType": "BadgeClass",
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "id": "68e9d238c5afe622816febb3",
  "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
  "imageAltText": "text",
  "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
  "originalJson": "{}",
  "preferences": {
    "customPropertyValues": [
      {
        "arrayValue": [
          "text"
        ],
        "doubleValue": 1,
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "public": true,
        "stringValue": "text"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "source": "local",
  "sourceUrl": "https://example.com/badge-classes/1",
  "tags": [
    "text"
  ]
}

Get a list of BadgeClasses for a single Issuer

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Query parameters
include_archivedbooleanOptionalDefault: false
Responses
200

OK

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/issuers/{idOrEntityId}/badgeclasses
GET /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Create a new BadgeClass associated with an Issuer

post
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
idOrEntityIdstringRequired
Body
achievementTypestring · nullableOptional

The type of achievement

Example: Course
criteriaNarrativestring · nullableOptional

Markdown formatted description of the criteria

criteriaUrlstring · uri · nullableOptional

External URL that describes in a human-readable format the criteria for the BadgeClass

Example: https://example.com/badge-classes/1/criteria
descriptionstring · max: 16384 · nullableRequired

Short description of the BadgeClass

Example: This badge is awarded to students who have demonstrated mastery of Math.
imagestring · nullableRequired

Image of the badge class as a base64-encoded data URI. External URLs are not allowed.

Example: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==
imageAltTextstring · nullableOptional
issuerstring · nullableOptional

Entity ID of the issuer

Example: ZvYydoQhRtOKalNzFPZR2A-Q
namestring · max: 1024 · nullableRequired

Name of the BadgeClass

Example: Math Expert
tagsstring[] · nullableOptional

List of tags that describe the BadgeClass

Responses
201

Created

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/issuers/{idOrEntityId}/badgeclasses
POST /v2/issuers/{idOrEntityId}/badgeclasses HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1087

{
  "achievementType": "Course",
  "alignments": [
    {
      "displayAsSkill": true,
      "targetCode": "text",
      "targetDescription": "text",
      "targetFramework": "text",
      "targetName": "text",
      "targetUrl": "text"
    }
  ],
  "criteriaNarrative": "text",
  "criteriaUrl": "https://example.com/badge-classes/1/criteria",
  "description": "This badge is awarded to students who have demonstrated mastery of Math.",
  "expires": {
    "amount": 30,
    "duration": "days"
  },
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "image": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+P+/HgAFhQJ/6+gQDQAAAABJRU5ErkJggg==",
  "imageAltText": "text",
  "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
  "name": "Math Expert",
  "ob3Properties": {
    "creditHours": 36,
    "fieldOfStudy": "Research",
    "humanCode": "R1",
    "specialization": "Computer Science Research"
  },
  "preferences": {
    "customPropertyValues": [
      {
        "arrayValue": [
          "text"
        ],
        "doubleValue": 1,
        "propertyId": "67b32887e2a7a7d5f7adabf1",
        "public": true,
        "stringValue": "text"
      }
    ],
    "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
    "enabledPrintCertTemplateIds": [
      "61e9d238c5afe622816febb3"
    ],
    "includeOnPublicPages": true
  },
  "tags": [
    "text"
  ]
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "achievementType": "Course",
      "alignments": [
        {
          "displayAsSkill": true,
          "targetCode": "text",
          "targetDescription": "text",
          "targetFramework": "text",
          "targetName": "text",
          "targetUrl": "text"
        }
      ],
      "archivalNote": "text",
      "archived": true,
      "archivedDate": "2026-01-01T00:00:00.000Z",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "criteriaNarrative": "text",
      "criteriaUrl": "https://example.com/badge-classes/1/criteria",
      "description": "This badge is awarded to students who have demonstrated mastery of Math.",
      "entityId": "iOMWsaF1QbmMCofM54JlUg",
      "entityType": "BadgeClass",
      "expires": {
        "amount": 30,
        "duration": "days"
      },
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "68e9d238c5afe622816febb3",
      "image": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg/image",
      "imageAltText": "text",
      "imagePath": "uploads/badges/badgeclass-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "name": "Math Expert",
      "ob3Properties": {
        "creditHours": 36,
        "fieldOfStudy": "Research",
        "humanCode": "R1",
        "specialization": "Computer Science Research"
      },
      "openBadgeId": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg",
      "originalJson": "{}",
      "preferences": {
        "customPropertyValues": [
          {
            "arrayValue": [
              "text"
            ],
            "doubleValue": 1,
            "propertyId": "67b32887e2a7a7d5f7adabf1",
            "public": true,
            "stringValue": "text"
          }
        ],
        "defaultPrintCertTemplateId": "61e9d238c5afe622816febb3",
        "enabledPrintCertTemplateIds": [
          "61e9d238c5afe622816febb3"
        ],
        "includeOnPublicPages": true
      },
      "source": "local",
      "sourceUrl": "https://example.com/badge-classes/1",
      "tags": [
        "text"
      ]
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Get list of Assertions for the specified scope

get
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
scopestring · enumRequiredPossible values:
idOrEntityIdstringRequired
Query parameters
recipientstringOptional

A recipient identifier to filter by

numinteger · int32Optional

Request pagination of results, before/after cursors may be provided in response header

include_expiredbooleanOptionalDefault: false
include_revokedbooleanOptionalDefault: false
afterstringOptional

Pagination cursor provided in "Link" response header

beforestringOptional

Pagination cursor provided in "Link" response header

Responses
200

List of Assertions

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
get/v2/{scope}/{idOrEntityId}/assertions
GET /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "acceptance": "Unaccepted",
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "entityType": "Assertion",
      "evidence": [
        {
          "audience": "text",
          "description": "text",
          "genre": "text",
          "name": "text",
          "narrative": "text",
          "url": "https://example.com"
        }
      ],
      "expires": "2026-01-01T00:00:00.000Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6116c84d1ff787222b6c4d15",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuedOn": "2026-01-01T00:00:00.000Z",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "narrative": "text",
      "ob3AwardProperties": {
        "activityEnd": "2026-01-01T00:00:00.000Z",
        "activityStart": "2026-01-01T00:00:00.000Z",
        "licenseNumber": "text",
        "role": "text"
      },
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "originalJson": "{}",
      "pending": true,
      "recipient": {
        "hashed": true,
        "identity": "sha256$4c2657856f",
        "plaintextIdentity": "jane.doe@example.com",
        "salt": "jgsu868",
        "type": "email"
      },
      "revocationReason": "text",
      "revoked": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}

Issue a new Assertion to a recipient

post
Required scopes
This endpoint requires the following scopes:
  • : Award badges and update your issuers
Authorizations
OAuth2authorizationCodeRequired

OAuth2 authorizationCode flow is currently not functional on the Swagger UI.

Authorization URL: Token URL:
Path parameters
scopestring · enumRequiredPossible values:
idOrEntityIdstringRequired

The entity ID of the selected scope entity

Example: K829IK8RS6ercwkpeFOn-Q
Body

Request to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.

allowDuplicateAwardsbooleanOptional

If set to false and the recipient already has this assertion, then the request will fail

badgeclassstring · nullableOptional

ID or Entity ID of the badge class to be awarded

Example: K829IK8RS6ercwkpeFOn-Q
badgeclassOpenBadgeIdstring · uri · nullableOptional

OB URL of the badge class to be awarded

Example: https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q
expiresstring · date-time · nullableOptional
issuedOnstring · date-time · nullableOptional

Timestamp when the assertion was issued

narrativestring · nullableOptional

Markdown narrative of the achievement

Responses
201

Created

errorCodestring · nullableOptional
latestTermsVersioninteger · int32 · nullableOptional
nonFieldErrorsstring[]Required
timestampstring · date-time · nullableOptional
validationErrorsstring[]Required
post/v2/{scope}/{idOrEntityId}/assertions
POST /v2/{scope}/{idOrEntityId}/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 650

{
  "allowDuplicateAwards": true,
  "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
  "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
  "evidence": [
    {
      "audience": "text",
      "description": "text",
      "genre": "text",
      "name": "text",
      "narrative": "text",
      "url": "https://example.com"
    }
  ],
  "expires": "2026-01-01T00:00:00.000Z",
  "extensions": {
    "value": {
      "ANY_ADDITIONAL_PROPERTY": {}
    }
  },
  "issuedOn": "2026-01-01T00:00:00.000Z",
  "narrative": "text",
  "ob3AwardProperties": {
    "activityEnd": "2026-01-01T00:00:00.000Z",
    "activityStart": "2026-01-01T00:00:00.000Z",
    "licenseNumber": "text",
    "role": "text"
  },
  "recipient": {
    "hashed": true,
    "identity": "jane.doe@example.com",
    "type": "email"
  }
}
{
  "errorCode": "text",
  "fieldErrors": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  },
  "latestTermsVersion": 1,
  "nonFieldErrors": [
    "text"
  ],
  "result": [
    {
      "acceptance": "Unaccepted",
      "assertionRef": {
        "assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
      },
      "badgeRef": {
        "badgeUrl": "https://api.badgr.io/public/badges/iOMWsaF1QbmMCofM54JlUg"
      },
      "badgeclass": "K829IK8RS6ercwkpeFOn-Q",
      "badgeclassOpenBadgeId": "https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-Q",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "Hey7J-GRSJeu6FNnHQwNyw",
      "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
      "entityType": "Assertion",
      "evidence": [
        {
          "audience": "text",
          "description": "text",
          "genre": "text",
          "name": "text",
          "narrative": "text",
          "url": "https://example.com"
        }
      ],
      "expires": "2026-01-01T00:00:00.000Z",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {}
      },
      "id": "6116c84d1ff787222b6c4d15",
      "image": "https://api.badgr.io/public/assertions/SsCfI7FlTr6hAJe4irXnfQ/image",
      "imagePath": "uploads/badges/assertion-lY1LJ6K4RqG7ThGLYvWNng.png",
      "issuedOn": "2026-01-01T00:00:00.000Z",
      "issuer": "ZvYydoQhRtOKalNzFPZR2A-Q",
      "issuerOpenBadgeId": "https://api.badgr.io/public/issuers/ZvYydoQhRtOKalNzFPZR2A",
      "issuerRef": {
        "issuerUrl": "https://api.badgr.ws/public/issuers/Uu4wd2I1SKmD3vmtMJ19hw"
      },
      "narrative": "text",
      "ob3AwardProperties": {
        "activityEnd": "2026-01-01T00:00:00.000Z",
        "activityStart": "2026-01-01T00:00:00.000Z",
        "licenseNumber": "text",
        "role": "text"
      },
      "openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
      "originalJson": "{}",
      "pending": true,
      "recipient": {
        "hashed": true,
        "identity": "sha256$4c2657856f",
        "plaintextIdentity": "jane.doe@example.com",
        "salt": "jgsu868",
        "type": "email"
      },
      "revocationReason": "text",
      "revoked": true,
      "source": "local",
      "sourceUrl": "https://example.com/assertions/1"
    }
  ],
  "status": {
    "description": "ok",
    "success": true
  },
  "timestamp": "2026-01-01T00:00:00.000Z",
  "validationErrors": [
    "text"
  ],
  "warnings": {
    "ANY_ADDITIONAL_PROPERTY": [
      "text"
    ]
  }
}
PreviousBackpackNextBadgeconnect

Last updated

Was this helpful?