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.
Partner Onboarding
Before you can use the YoID API, your organisation must complete a partner setup handled by the YoID team.Request access
Contact the YoID team with your organisation name, a brief description of your use case (issuing, verifying, or both), and a technical contact email.
Credential creation
The YoID team creates a unique
clientId and clientSecret for your organisation in the Product Hub realm.What to Have Ready
| Item | Details |
|---|---|
| Organisation name | How your org appears in credential metadata |
| Use case | Are you issuing credentials, verifying them, or both? |
| Technical contact | Email of the developer who will implement the integration |
| Webhook URL (optional) | An HTTPS endpoint to receive real-time event notifications |
Developer Requirements
Your application must be able to:- Exchange credentials for tokens — standard OAuth
client_credentialsflow via Keycloak - Handle short-lived tokens — access tokens expire after 300 seconds (5 minutes) with no refresh token support
- Make HTTPS requests — all API communication uses TLS
Understanding the Two Realms
Your organisation and the youth you credential operate in separate authentication contexts:- Product Hub — your organisation’s realm. Your
clientIdandclientSecretlive here. All API calls use tokens from this realm. - Consumers — the youth wallet realm. You don’t manage this directly, but it’s why credential delivery is asynchronous.
Next Steps
Once you have yourclientId and clientSecret, proceed to Authentication to learn how to obtain and manage access tokens.