Issue Digital Badge

POST

/api/digitalbadges/{legalEntityId}/templates/{badgeTemplateId}/issueBadge

Issues a digital badge to an individual in real-time using the details provided. A digital badge "template" must already have been created within tahdah using the admin interface and you will need to obtain the id for the template using getTemplates API call or from the URL within the admin interface.

Your API token must have a role with permission to issue digital badges for the legal entity you supply in the url.

Tahdah will attempt to find the details of the learner/candidate that you provide from your unique id first, the candidate id second and then by email address. If there is no match then a new record will be created, if there is a match but some of hte information you provide is incorrect then you will recieve an error back.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "Forename": "string",
    "Surname": "string",
    "DOB": "2019-08-24",
    "Email": "user@example.com",
    "Identifier": "L5566",
    "CandidateId": 1
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.tahdah.me/api/digitalbadges//templates//issueBadge' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Forename": "string",
    "Surname": "string",
    "DOB": "2019-08-24",
    "Email": "user@example.com",
    "Identifier": "L5566",
    "CandidateId": 1
}'

Responses

🟢200Success

application/json

Body

Example

{
    "legalEntityId": 1,
    "badgeTemplateId": 1,
    "Id": 1
}

Modified at 2025-05-15 14:13:26

Get Learning Experience

Get Badge Templates