Badgeconnect

Get assertions for the authenticated user

get

Returns a paginated list of OB 2.1 assertions for the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : List assertions in your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

sincestring · date-timeOptional

Responses

200

Assertions retrieved successfully

application/ld+json

400

Bad Request

*/*

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

get

/bcv1/ims/ob/v2p1/assertions

HTTPcURLJavaScriptPython

GET /bcv1/ims/ob/v2p1/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  },
  "assertions": [
    {
      "id": "text",
      "@context": "text",
      "recipient": {
        "type": "text",
        "salt": "text",
        "hashed": true,
        "identity": "text"
      },
      "badge": "https://example.com/badges/1",
      "issuedOn": "2026-04-02T01:53:36.879Z",
      "image": {
        "id": "text",
        "caption": "text"
      },
      "evidence": [
        "text"
      ],
      "narrative": "text",
      "expires": "2026-04-02T01:53:36.879Z",
      "revoked": true,
      "revocationReason": "text",
      "verification": {
        "type": "HostedBadge",
        "verificationProperty": "text",
        "startsWith": "text",
        "allowedOrigins": [
          "text"
        ],
        "url": "text",
        "creator": "text"
      },
      "type": "text"
    }
  ]
}

Import an assertion

post

Import an OB 2.1 assertion by URL into the authenticated user's backpack

Required scopes

This endpoint requires the following scopes:

• : Upload badges to your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Body

application/json

stringOptional

Responses

200

Assertion imported successfully

application/ld+json

400

Invalid request or failed to import

application/ld+json

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

post

/bcv1/ims/ob/v2p1/assertions

HTTPcURLJavaScriptPython

POST /bcv1/ims/ob/v2p1/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  }
}

Get assertions for the authenticated user

get

Returns a paginated list of OB 2.1 assertions for the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : List assertions in your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Query parameters

limitinteger · int32Optional

offsetinteger · int32Optional

sincestring · date-timeOptional

Responses

200

Assertions retrieved successfully

application/ld+json

400

Bad Request

*/*

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

get

/bcv1/assertions

HTTPcURLJavaScriptPython

GET /bcv1/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  },
  "assertions": [
    {
      "id": "text",
      "@context": "text",
      "recipient": {
        "type": "text",
        "salt": "text",
        "hashed": true,
        "identity": "text"
      },
      "badge": "https://example.com/badges/1",
      "issuedOn": "2026-04-02T01:53:36.879Z",
      "image": {
        "id": "text",
        "caption": "text"
      },
      "evidence": [
        "text"
      ],
      "narrative": "text",
      "expires": "2026-04-02T01:53:36.879Z",
      "revoked": true,
      "revocationReason": "text",
      "verification": {
        "type": "HostedBadge",
        "verificationProperty": "text",
        "startsWith": "text",
        "allowedOrigins": [
          "text"
        ],
        "url": "text",
        "creator": "text"
      },
      "type": "text"
    }
  ]
}

Import an assertion

post

Import an OB 2.1 assertion by URL into the authenticated user's backpack

Required scopes

This endpoint requires the following scopes:

• : Upload badges to your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Body

application/json

stringOptional

Responses

200

Assertion imported successfully

application/ld+json

400

Invalid request or failed to import

application/ld+json

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

post

/bcv1/assertions

HTTPcURLJavaScriptPython

POST /bcv1/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 6

"text"

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  }
}

Get the authenticated user's profile

get

Returns the OB 3.0 profile of the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : See who you are

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Responses

200

Profile retrieved successfully

*/*

@contextstring[]Required

typestring[]Required

namestringOptional

emailstringOptional

phonestringOptional

urlstringOptional

400

Bad Request

*/*

403

Access denied

*/*

get

/ims/ob/v3p0/profile

HTTPcURLJavaScriptPython

GET /ims/ob/v3p0/profile HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "@context": [
    "text"
  ],
  "type": [
    "text"
  ],
  "name": "text",
  "email": "text",
  "phone": "text",
  "url": "text"
}

Get the OB 3.0 service discovery document

get

Returns the Badge Connect service descriptor for OB 3.0 API discovery

Authorizations

accessToken

HTTPRequired

Responses

200

Service descriptor retrieved successfully

application/json

400

Bad Request

*/*

get

/ims/ob/v3p0/discovery

HTTPcURLJavaScriptPython

GET /ims/ob/v3p0/discovery HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "openapi": "3.0.1",
  "info": {
    "title": "OpenAPI schema for Open Badges",
    "version": "3.0"
  },
  "servers": [
    {
      "url": "https://api.badgr.com/ims/ob/v3p0"
    }
  ],
  "paths": {
    "/credentials": {
      "get": {
        "summary": "Get verifiable credentials",
        "operationId": "getCredentials"
      }
    },
    "/profile": {
      "get": {
        "summary": "Get user profile",
        "operationId": "getProfile"
      }
    }
  }
}

Get verifiable credentials for the authenticated user

get

Returns a paginated list of signed OB 3.0 verifiable credentials for the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : List assertions in your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Query parameters

limitinteger · int32OptionalDefault: 20

offsetinteger · int32OptionalDefault: 0

sincestring · date-timeOptional

Responses

200

Credentials retrieved successfully

*/*

400

Invalid request parameters

*/*

401

Unauthorized

*/*

403

Access denied

*/*

get

/ims/ob/v3p0/credentials

HTTPcURLJavaScriptPython

GET /ims/ob/v3p0/credentials HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "credential": [
    {
      "id": "text",
      "@context": [
        "text"
      ],
      "type": [
        "text"
      ],
      "issuer": {
        "id": "text",
        "type": [
          "text"
        ],
        "url": "text",
        "name": "text",
        "email": "text",
        "description": "text"
      },
      "validFrom": "text",
      "validUntil": "text",
      "name": "text",
      "description": "text",
      "image": {
        "id": "text",
        "caption": "text"
      },
      "credentialSubject": {
        "identifier": [
          {
            "type": "text",
            "hashed": true,
            "identityHash": "text",
            "identityType": "emailAddress",
            "salt": "text"
          }
        ],
        "type": [
          "text"
        ],
        "achievement": {
          "id": "text",
          "type": [
            "text"
          ],
          "criteria": {
            "id": "text",
            "narrative": "text"
          },
          "description": "text",
          "name": "text",
          "alignment": [
            {
              "type": [
                "text"
              ],
              "targetName": "text",
              "targetUrl": "text",
              "targetCode": "text",
              "targetDescription": "text",
              "targetFramework": "text",
              "targetType": "ceasn:Competency"
            }
          ],
          "achievementType": "Achievement",
          "creditsAvailable": 1,
          "fieldOfStudy": "text",
          "humanCode": "text",
          "specialization": "text",
          "image": {
            "id": "text",
            "caption": "text"
          }
        },
        "narrative": "text",
        "activityStart": "2026-04-02T01:53:36.879Z",
        "activityEnd": "2026-04-02T01:53:36.879Z",
        "licenseNumber": "text",
        "role": "text"
      },
      "credentialStatus": {
        "id": "text",
        "type": "text"
      },
      "proof": [
        {
          "type": "text",
          "created": "text",
          "cryptosuite": "text",
          "proofPurpose": "text",
          "proofValue": "text",
          "verificationMethod": "text"
        }
      ],
      "evidence": [
        {
          "id": "text",
          "narrative": "text",
          "name": "text",
          "description": "text",
          "genre": "text",
          "audience": "text"
        }
      ],
      "credentialSchema": [
        {
          "id": "text",
          "type": "text"
        }
      ]
    }
  ]
}

Get OB 2.1 assertions via OB 3.0 path

get

Forwards to the Badge Connect v1 assertions endpoint for backward compatibility

Required scopes

This endpoint requires the following scopes:

• : List assertions in your backpack

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Responses

200

Assertions retrieved successfully. Response format is the same as the OB 2.1 GET /assertions endpoint.

application/ld+json

400

Bad Request

*/*

get

/ims/ob/v3p0/assertions

HTTPcURLJavaScriptPython

GET /ims/ob/v3p0/assertions HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  },
  "assertions": [
    {
      "id": "text",
      "@context": "text",
      "recipient": {
        "type": "text",
        "salt": "text",
        "hashed": true,
        "identity": "text"
      },
      "badge": "https://example.com/badges/1",
      "issuedOn": "2026-04-02T01:53:36.879Z",
      "image": {
        "id": "text",
        "caption": "text"
      },
      "evidence": [
        "text"
      ],
      "narrative": "text",
      "expires": "2026-04-02T01:53:36.879Z",
      "revoked": true,
      "revocationReason": "text",
      "verification": {
        "type": "HostedBadge",
        "verificationProperty": "text",
        "startsWith": "text",
        "allowedOrigins": [
          "text"
        ],
        "url": "text",
        "creator": "text"
      },
      "type": "text"
    }
  ]
}

Get the Badge Connect manifest for a domain

get

Returns the Badge Connect service discovery manifest for the specified domain

Authorizations

accessToken

HTTPRequired

Path parameters

domainstringRequired

Responses

200

Manifest retrieved successfully

application/ld+json

idstringRequired

@contextstringRequired

400

Bad Request

*/*

404

Domain not found

application/ld+json

get

/bcv1/manifest/{domain}

HTTPcURLJavaScriptPython

GET /bcv1/manifest/{domain} HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "badgeConnectAPI": [
    {
      "name": "text",
      "image": "text",
      "apiBase": "text",
      "version": "text",
      "termsOfServiceUrl": "text",
      "privacyPolicyUrl": "text",
      "scopesOffered": [
        "text"
      ],
      "registrationUrl": "text",
      "authorizationUrl": "text",
      "tokenUrl": "text"
    }
  ],
  "@context": "text"
}

Get the authenticated user's profile

get

Returns the OB 2.1 profile of the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : See who you are

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Responses

200

Profile retrieved successfully

application/ld+json

400

Bad Request

*/*

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

get

/bcv1/profile

HTTPcURLJavaScriptPython

GET /bcv1/profile HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  },
  "profile": {
    "name": "text",
    "email": "text",
    "url": "text",
    "telephone": "text",
    "id": "text",
    "type": "text",
    "@context": "text"
  }
}

Get the authenticated user's profile

get

Returns the OB 2.1 profile of the authenticated badge recipient

Required scopes

This endpoint requires the following scopes:

• : See who you are

Authorizations

oauthaccessToken

OAuth2authorizationCodeRequired

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

Authorization URL: Token URL:

Responses

200

Profile retrieved successfully

application/ld+json

400

Bad Request

*/*

401

Unauthorized

application/ld+json

404

User not found

application/ld+json

get

/bcv1/ims/ob/v2p1/profile

HTTPcURLJavaScriptPython

GET /bcv1/ims/ob/v2p1/profile HTTP/1.1
Host: api.badges.parchment.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "status": {
    "error": "text",
    "statusCode": 1,
    "statusText": "text"
  },
  "profile": {
    "name": "text",
    "email": "text",
    "url": "text",
    "telephone": "text",
    "id": "text",
    "type": "text",
    "@context": "text"
  }
}