Assertions
- : Read badge classes and assertions in your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
IDs or entity IDs of the assertions or credentials.
OK
Bad Request
Not Found
Too Many Requests
Internal Server Error
GET /v2/assertions/creation-methods?ids=text HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"assertions": [
{
"creationMethod": {
"type": "text",
"courseUrl": "text",
"lmsPlatform": "CANVAS"
},
"entityId": "text",
"id": "text"
}
]
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Error code if assertion could not be revoked
Entity ID of the Assertion to revoke
i9CirfwJTuSfiqg0FFUBdQID of the Assertion to revoke
62aa04adf5afe00d0a6dac72Error reason if assertion could not be revoked
Short description of why the Assertion is being revoked
Course was cancelledOK
Bad Request
Not Found
Too Many Requests
Internal Server Error
POST /v2/assertions/revoke HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 113
[
{
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"id": "62aa04adf5afe00d0a6dac72",
"revocationReason": "Course was cancelled"
}
]{
"errorCode": "text",
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1,
"nonFieldErrors": [
"text"
],
"result": [
{
"code": "text",
"entityId": "i9CirfwJTuSfiqg0FFUBdQ",
"id": "62aa04adf5afe00d0a6dac72",
"reason": "text",
"revocationReason": "Course was cancelled",
"revoked": true
}
],
"status": {
"description": "ok",
"success": true
},
"timestamp": "2026-01-01T00:00:00.000Z",
"validationErrors": [
"text"
],
"warnings": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
}
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
Not Found
Too Many Requests
Internal Server Error
DELETE /v2/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 28
{
"revocation_reason": "text"
}{
"errorCode": "text",
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1,
"nonFieldErrors": [
"text"
],
"result": [
{
"acceptance": "Unaccepted",
"assertionRef": {
"assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
},
"awardType": "ASSERTION",
"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"
},
"objectiveRelationship": {
"activeLink": true,
"objectiveDefinitionId": "6116c84d1ff787222b6c4d15",
"objectiveProgressId": "6116c84d1ff787222b6c4d16",
"recipientGroupId": "6116c84d1ff787222b6c4d17"
},
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"originalJson": "{}",
"pending": true,
"public": 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"
]
}
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
OK
Bad Request
Not Found
Too Many Requests
Internal Server Error
GET /v2/assertions/{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": [
{
"acceptance": "Unaccepted",
"assertionRef": {
"assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
},
"awardType": "ASSERTION",
"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"
},
"objectiveRelationship": {
"activeLink": true,
"objectiveDefinitionId": "6116c84d1ff787222b6c4d15",
"objectiveProgressId": "6116c84d1ff787222b6c4d16",
"recipientGroupId": "6116c84d1ff787222b6c4d17"
},
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"originalJson": "{}",
"pending": true,
"public": 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"
]
}
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
Timestamp when the assertion was issued
Markdown narrative of the achievement
OK
Bad Request
Not Found
Too Many Requests
Internal Server Error
PUT /v2/assertions/{idOrEntityId} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 408
{
"evidence": [
{
"audience": "text",
"description": "text",
"genre": "text",
"name": "text",
"narrative": "text",
"url": "text"
}
],
"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"
}
}{
"errorCode": "text",
"fieldErrors": {
"ANY_ADDITIONAL_PROPERTY": [
"text"
]
},
"latestTermsVersion": 1,
"nonFieldErrors": [
"text"
],
"result": [
{
"acceptance": "Unaccepted",
"assertionRef": {
"assertionUrl": "https://api.badgr.io/public/assertions/lY1LJ6K4RqG7ThGLYvWNng"
},
"awardType": "ASSERTION",
"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"
},
"objectiveRelationship": {
"activeLink": true,
"objectiveDefinitionId": "6116c84d1ff787222b6c4d15",
"objectiveProgressId": "6116c84d1ff787222b6c4d16",
"recipientGroupId": "6116c84d1ff787222b6c4d17"
},
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"originalJson": "{}",
"pending": true,
"public": 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"
]
}
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
A recipient identifier to filter by
Request pagination of results, before/after cursors may be provided in response header
falsefalsePagination cursor provided in "Link" response header
Pagination cursor provided in "Link" response header
List of Assertions
Bad Request
Not Found
Too Many Requests
Internal Server Error
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"
},
"awardType": "ASSERTION",
"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"
},
"objectiveRelationship": {
"activeLink": true,
"objectiveDefinitionId": "6116c84d1ff787222b6c4d15",
"objectiveProgressId": "6116c84d1ff787222b6c4d16",
"recipientGroupId": "6116c84d1ff787222b6c4d17"
},
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"originalJson": "{}",
"pending": true,
"public": 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"
]
}
}- : Award badges and update your issuers
OAuth2 authorizationCode flow is currently not functional on the Swagger UI.
The entity ID of the selected scope entity
K829IK8RS6ercwkpeFOn-QRequest to award an assertion. When request scope is issuers, one of badgeclass or badgeclassOpenBadgeId must be provided.
If set to false and the recipient already has this assertion, then the request will fail
ID or Entity ID of the badge class to be awarded
K829IK8RS6ercwkpeFOn-QOB URL of the badge class to be awarded
https://api.badgr.io/public/badges/K829IK8RS6ercwkpeFOn-QTimestamp when the assertion was issued
Markdown narrative of the achievement
Created
Bad Request
Not Found
Too Many Requests
Internal Server Error
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"
},
"awardType": "ASSERTION",
"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"
},
"objectiveRelationship": {
"activeLink": true,
"objectiveDefinitionId": "6116c84d1ff787222b6c4d15",
"objectiveProgressId": "6116c84d1ff787222b6c4d16",
"recipientGroupId": "6116c84d1ff787222b6c4d17"
},
"openBadgeId": "https://api.badgr.io/public/assertions/i9CirfwJTuSfiqg0FFUBdQ",
"originalJson": "{}",
"pending": true,
"public": 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"
]
}
}Last updated
Was this helpful?