Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yoid.me/llms.txt

Use this file to discover all available pages before exploring further.

Overview

As a learning or impact partner, you use the YoID platform to create digital credentials and deliver them to youth wallets. Credentials can be issued regardless of whether the youth has activated their wallet — if they haven’t, the credential is held in custody until they sign in.

APIs Used

APIPurpose
Consumer Onboarding APIProvision a youth account — creates a Keycloak identity in the Consumers realm and initialises a wallet tenant
Me Creds APICreate credential templates and issue credentials
Me Wallet APIDeliver credential offers to the youth’s wallet

Issuance Workflow

1

Create Youth Account

Provision a youth account and wallet — Step 1
2

Create Credential Template

Define the structure and attributes of the credential (done once per credential type) — Step 2
3

Issue a Credential

Generate a credential offer with the youth’s specific data — Step 3
4

Send Credential Offer to Wallet

Deliver the credential to the youth’s wallet — Step 4

Example

When Thandi completes Umuzi’s web development programme:
  1. Umuzi already created her youth account during programme onboarding
  2. They have a reusable “Web Development Completion” credential template
  3. They issue a credential with her completion data
  4. They deliver the offer to her wallet