Community Card API Key

What is this API for?

This API lets you generate unique links to distribute badges to specific users. Each generated link can be customized with an email address and an optional note.
It offers:

Unique links: generate personalized claim links for badge distribution
Email targeting: optionally associate links with specific user emails
Flexible integration: simple REST API with instant link generation

Generating your API key

Go to the API Configuration tab of the Community Card.
Click Generate API key.
Your key is displayed in the Your API key field, with the status Active.
- Use the eye icon to reveal it in plain text.
- Use the copy icon to copy it to your clipboard.

⚠️ Keep your API key secure. Don't share it publicly and don't store it in a code repository.

How to use the API

API endpoint

POST https://badgebot.mydid.com/api/v1/auth/sessions/builders/create

Example request

curl -X POST https://badgebot.mydid.com/api/v1/auth/sessions/builders/create \
  -H "Content-Type: application/json" \
  -d '{
    "apiKey": "YOUR_API_KEY",
    "email": "user@example.com",
    "note": "Welcome bonus badge"
  }'

Example response

{
  "links": [
    "https://mydid.page.link/iHu1WKFuPHADvEaH9"
  ]
}

Full documentation

For the complete API reference, authentication details, and advanced usage examples, see the dedicated technical documentation: 👉 https://swagger.mydid.com/

Updated on: 10/07/2026

Was this article helpful?

Thank you!