MIRACL Trust OIDC API

# MIRACL Trust OIDC API Endpoints

  • Authorization Endpoint - This API serves the authentication page.
  • Token Endpoint - This API returns the access and ID tokens.
  • UserInfo Endpoint - This API returns information about the authenticated user.
  • JWKS URI - This API returns a JSON Web Key Set (JWKS) that contains the public keys that can be used to verify the signatures of tokens that you receive from your authorization server.
  • Configuration Discovery - This API returns OIDC metadata that can be used by clients for automatic configuration.

# Supported Scopes

ScopeTypeDescription
openidStandardMust always be included.
emailStandardRequests access to the email and email_verified claims.
dvsCustomRequests access to the dvs_keys claim. Required in order to execute DVS related operations after authentication.
mpin_idCustomRequests access to the mpin_id claim.
hash_mpin_idCustomRequests access to the hash_mpin_id claim.

# Supported Claims

ClaimTypeDescription
subStandardIdentifier for the end user. Set to the user’s email address if using the built-in verification or the provided User ID for custom user verification . Always present.
issStandardThe issuer identifier for MIRACL Trust. Always present.
emailStandardEnd user’s e-mail address. Present only if the email scope is included.
email_verifiedStandard“True” if the end user’s e-mail address has been verified; otherwise, “false”. Present only if the email scope is included.
mpin_idCustomPresent only if the mpin_id scope is included.
hash_mpin_idCustomPresent only if the hash_mpin_id scope is included.
dvs_keysCustomPresent only if the dvs scope is included.