# YoID Docs ## Docs - [Onboard a user in the authenticated tenant.](https://docs.yoid.me/api-reference/consumer-onboarding/create-user.md): Creates or resolves a user by email and/or username. At least one of email or username must be provided. Behavior varies by combination — see 409 responses for conflict scenarios. - [Look up a user's external identifier by username in the authenticated tenant.](https://docs.yoid.me/api-reference/consumer-onboarding/get-external-identifier.md) - [Look up a user by external identifier in the authenticated tenant.](https://docs.yoid.me/api-reference/consumer-onboarding/get-user-by-external-identifier.md) - [Get all users in the authenticated tenant.](https://docs.yoid.me/api-reference/consumer-onboarding/list-users.md) - [Enable or disable a federated identity link for a user.](https://docs.yoid.me/api-reference/consumer-onboarding/update-idp-link.md): Creates or removes a Keycloak federated identity link between the user and the tenant IDP. Fully idempotent. - [Activate a certificate](https://docs.yoid.me/api-reference/me-creds/certificates/activate-certificate.md) - [Create a certificate signing request](https://docs.yoid.me/api-reference/me-creds/certificates/create-csr.md) - [Create a root certificate](https://docs.yoid.me/api-reference/me-creds/certificates/create-root-certificate.md) - [Deactivate a certificate](https://docs.yoid.me/api-reference/me-creds/certificates/deactivate-certificate.md) - [Delete a certificate signing request](https://docs.yoid.me/api-reference/me-creds/certificates/delete-csr.md) - [Import certificate for a certificate signing request](https://docs.yoid.me/api-reference/me-creds/certificates/import-certificate-for-csr.md) - [Get all certificates](https://docs.yoid.me/api-reference/me-creds/certificates/list-certificates.md) - [Get all certificate signing requests](https://docs.yoid.me/api-reference/me-creds/certificates/list-csrs.md) - [Revoke a certificate](https://docs.yoid.me/api-reference/me-creds/certificates/revoke-certificate.md) - [Create a new issuance](https://docs.yoid.me/api-reference/me-creds/credentials/create-issuance.md) - [Get credential by id](https://docs.yoid.me/api-reference/me-creds/credentials/get-credential.md) - [Get credential resources](https://docs.yoid.me/api-reference/me-creds/credentials/list-credentials.md) - [Revoke a credential by id.](https://docs.yoid.me/api-reference/me-creds/credentials/revoke-credential.md) - [Revoke multiple credentials by their ids.](https://docs.yoid.me/api-reference/me-creds/credentials/revoke-credentials.md) - [Create a new presentation](https://docs.yoid.me/api-reference/me-creds/presentations/create-presentation.md) - [Get presentation by id](https://docs.yoid.me/api-reference/me-creds/presentations/get-presentation.md) - [Get presentations](https://docs.yoid.me/api-reference/me-creds/presentations/list-presentations.md) - [Create a new credential preset.](https://docs.yoid.me/api-reference/me-creds/presets/credential-create-preset.md) - [Get credential preset by id.](https://docs.yoid.me/api-reference/me-creds/presets/credential-get-preset.md) - [Get credential presets.](https://docs.yoid.me/api-reference/me-creds/presets/credential-list-presets.md) - [Create a new presentation preset.](https://docs.yoid.me/api-reference/me-creds/presets/presentation-create-preset.md) - [Get presentation preset by id.](https://docs.yoid.me/api-reference/me-creds/presets/presentation-get-preset.md) - [Get presentation presets.](https://docs.yoid.me/api-reference/me-creds/presets/presentation-list-presets.md) - [Create a new credential template.](https://docs.yoid.me/api-reference/me-creds/templates/credential-create-template.md) - [Delete credential template by id.](https://docs.yoid.me/api-reference/me-creds/templates/credential-delete-template.md) - [Get credential template by id.](https://docs.yoid.me/api-reference/me-creds/templates/credential-get-template.md) - [Get credential templates.](https://docs.yoid.me/api-reference/me-creds/templates/credential-list-templates.md) - [Create a new presentation template.](https://docs.yoid.me/api-reference/me-creds/templates/presentation-create-template.md) - [Delete presentation template by id.](https://docs.yoid.me/api-reference/me-creds/templates/presentation-delete-template.md) - [Get presentation template by id.](https://docs.yoid.me/api-reference/me-creds/templates/presentation-get-template.md) - [Get presentation templates.](https://docs.yoid.me/api-reference/me-creds/templates/presentation-list-templates.md) - [Update a presentation template.](https://docs.yoid.me/api-reference/me-creds/templates/presentation-update-template.md) - [Create a new trusted entity](https://docs.yoid.me/api-reference/me-creds/trusted-entities/create-trusted-entity.md) - [Delete a trusted entity](https://docs.yoid.me/api-reference/me-creds/trusted-entities/delete-trusted-entity.md) - [Get trusted entity by id](https://docs.yoid.me/api-reference/me-creds/trusted-entities/get-trusted-entity.md) - [Get trusted entity resources](https://docs.yoid.me/api-reference/me-creds/trusted-entities/list-trusted-entities.md) - [Update a trusted entity](https://docs.yoid.me/api-reference/me-creds/trusted-entities/update-trusted-entity.md) - [Create a new endpoint destination for an organization.](https://docs.yoid.me/api-reference/me-creds/webhooks/create-endpoint.md) - [Delete endpoint destination by id.](https://docs.yoid.me/api-reference/me-creds/webhooks/delete-endpoint.md) - [Get endpoint destinations for an organization.](https://docs.yoid.me/api-reference/me-creds/webhooks/list-endpoints.md) - [Create credential resource.](https://docs.yoid.me/api-reference/me-wallet/credentials/create-credential.md) - [Create credential resource.](https://docs.yoid.me/api-reference/me-wallet/credentials/create-credential-v2.md) - [Discard an accepted credential.](https://docs.yoid.me/api-reference/me-wallet/credentials/discard-credential.md) - [Discard an accepted credential.](https://docs.yoid.me/api-reference/me-wallet/credentials/discard-credential-v2.md) - [Get credential by id.](https://docs.yoid.me/api-reference/me-wallet/credentials/get-credential.md) - [Get credential by ID.](https://docs.yoid.me/api-reference/me-wallet/credentials/get-credential-v2.md) - [Get credentials by status.](https://docs.yoid.me/api-reference/me-wallet/credentials/list-credentials.md): Retrieve credentials filtered by their consent status. The status query parameter is required. - [Get credentials by status.](https://docs.yoid.me/api-reference/me-wallet/credentials/list-credentials-v2.md) - [Update credential status.](https://docs.yoid.me/api-reference/me-wallet/credentials/update-credential-status.md) - [Update credential status.](https://docs.yoid.me/api-reference/me-wallet/credentials/update-credential-status-v2.md) - [Create credential resource for a user by an organization.](https://docs.yoid.me/api-reference/me-wallet/organizations/org-create-credential.md) - [Create credential resource for a user by an organization.](https://docs.yoid.me/api-reference/me-wallet/organizations/org-create-credential-v2.md) - [Send a presentation request to a user by email on behalf of an organization.](https://docs.yoid.me/api-reference/me-wallet/organizations/org-create-presentation.md) - [Send a presentation request to a user on behalf of an organization.](https://docs.yoid.me/api-reference/me-wallet/organizations/org-create-presentation-v2.md) - [Approve or reject a presentation.](https://docs.yoid.me/api-reference/me-wallet/presentations/approve-presentation-v2.md): Set status to "approved" to share matched credentials, or "rejected" to decline. - [Approve or reject a presentation.](https://docs.yoid.me/api-reference/me-wallet/presentations/approve-presentation-v2-legacy.md): Set action to "approve" to share matched credentials, or "reject" to decline. - [Create and auto-answer a presentation request.](https://docs.yoid.me/api-reference/me-wallet/presentations/create-presentation.md): Automatically matches credentials and sends the presentation response without user approval. - [Create a pending presentation.](https://docs.yoid.me/api-reference/me-wallet/presentations/create-presentation-v2.md): Matches credentials for the presentation request but does not auto-answer. User must explicitly approve or reject. - [Create a pending presentation.](https://docs.yoid.me/api-reference/me-wallet/presentations/create-presentation-v2-legacy.md): Matches credentials for the presentation request but does not auto-answer. User must explicitly approve or reject. - [Get presentation by id.](https://docs.yoid.me/api-reference/me-wallet/presentations/get-presentation.md) - [Get presentation by ID.](https://docs.yoid.me/api-reference/me-wallet/presentations/get-presentation-v2.md): Returns the presentation with matched credential information. - [Get presentation by ID.](https://docs.yoid.me/api-reference/me-wallet/presentations/get-presentation-v2-legacy.md): Returns the presentation with matched credential information. - [Get all presentations.](https://docs.yoid.me/api-reference/me-wallet/presentations/list-presentations.md) - [Get all presentations.](https://docs.yoid.me/api-reference/me-wallet/presentations/list-presentations-v2.md) - [Create a new tenant for a user](https://docs.yoid.me/api-reference/me-wallet/tenants/create-tenant.md) - [Create a new tenant for a user.](https://docs.yoid.me/api-reference/me-wallet/tenants/create-tenant-v2.md) - [Get tenant by user ID](https://docs.yoid.me/api-reference/me-wallet/tenants/get-tenant.md) - [Get tenant by user ID.](https://docs.yoid.me/api-reference/me-wallet/tenants/get-tenant-v2.md) - [Get current authenticated user information](https://docs.yoid.me/api-reference/me-wallet/users/get-whoami.md) - [Get current authenticated user information.](https://docs.yoid.me/api-reference/me-wallet/users/get-whoami-v2.md) - [Enable or disable a federated identity link for a user.](https://docs.yoid.me/api-reference/users/enable-or-disable-a-federated-identity-link-for-a-user.md): Creates or removes a Keycloak federated identity link between the user and the tenant IDP. Fully idempotent. - [Get all users in the authenticated tenant.](https://docs.yoid.me/api-reference/users/get-all-users-in-the-authenticated-tenant.md) - [Look up a user by external identifier in the authenticated tenant.](https://docs.yoid.me/api-reference/users/look-up-a-user-by-external-identifier-in-the-authenticated-tenant.md) - [Look up a user's external identifier by username in the authenticated tenant.](https://docs.yoid.me/api-reference/users/look-up-a-users-external-identifier-by-username-in-the-authenticated-tenant.md) - [Onboard a user in the authenticated tenant.](https://docs.yoid.me/api-reference/users/onboard-a-user-in-the-authenticated-tenant.md): Creates or resolves a user by email and/or username. At least one of email or username must be provided. Behavior varies by combination — see 409 responses for conflict scenarios. - [Authentication](https://docs.yoid.me/api/authentication.md): How to obtain and manage access tokens for the YoID API. - [Credential Revocation](https://docs.yoid.me/api/credential-revocation.md): Revoke credentials that are no longer valid. - [Error Handling](https://docs.yoid.me/api/error-handling.md): HTTP status codes and error response format for the YoID APIs. - [Introduction](https://docs.yoid.me/api/introduction.md): Integrate with YoID to issue and verify credentials across the YOMA ecosystem. - [Step 2: Create Credential Template](https://docs.yoid.me/api/issuers/create-credential-template.md): Define the structure and attributes of a verifiable credential. - [Step 1: Create Youth Account](https://docs.yoid.me/api/issuers/create-user-account.md): Provision a youth account and custodial wallet in the YoID system. - [Step 3: Issue a Credential](https://docs.yoid.me/api/issuers/issue-credential.md): Generate a credential offer from a template with the youth's specific data. - [Issuing Credentials](https://docs.yoid.me/api/issuers/overview.md): Issue verifiable credentials to youth using the YoID platform. - [Step 4: Send Credential Offer to Wallet](https://docs.yoid.me/api/issuers/send-credential-offer.md): Deliver the credential offer to the youth's wallet. - [Prerequisites](https://docs.yoid.me/api/prerequisites.md): What you need before integrating with the YoID platform. - [Step 2: Create a Presentation Request](https://docs.yoid.me/api/verifiers/create-presentation-request.md): Generate a specific verification request from a template. - [Step 1: Create a Presentation Template](https://docs.yoid.me/api/verifiers/create-presentation-template.md): Define what credential information you want to request from youth. - [Verifying Credentials](https://docs.yoid.me/api/verifiers/overview.md): Request and verify youth credentials using the YoID platform. - [Step 3: Present the Request to the Youth](https://docs.yoid.me/api/verifiers/present-request-to-user.md): Display the verification request to the youth via QR code or shareable link. - [Step 4: Verify Presentation](https://docs.yoid.me/api/verifiers/verify-presentation.md): Retrieve and validate the credential data shared by the youth. - [Webhooks](https://docs.yoid.me/api/webhooks.md): Receive real-time notifications for credential issuance and verification events. - [Ecosystem Actors](https://docs.yoid.me/ecosystem/actors.md): Who participates in the YOMA ecosystem, what they need, and how YoID serves them. - [Credentials Explained](https://docs.yoid.me/ecosystem/credentials-explained.md): How verifiable credentials work in the YOMA ecosystem — without the jargon. - [What is YoID?](https://docs.yoid.me/ecosystem/overview.md): A youth identity protocol powering verified pathways from learning to employment. - [YoID Documentation](https://docs.yoid.me/index.md): The verifiable identity protocol powering the YOMA learning-to-earning ecosystem. ## OpenAPI Specs - [me-wallet](https://docs.yoid.me/openapi/me-wallet.json) - [me-creds](https://docs.yoid.me/openapi/me-creds.json) - [consumer-onboarding](https://docs.yoid.me/openapi/consumer-onboarding.json)