Claim Mappings

Introduction

The JSON-LD claims defined in a standard Verifiable Credential can be mapped to OpenID Connect claims which are functionally equivalent. In practice, this is used when issuing a Credential and when verifying a Credential.

When issuing a Credential, the OIDC Provider (OP) of the issuer provides information in the form of standard OIDC claims which the platform translates into Verifiable Credential claims before ending up in the Mobile Wallet.

As part of verifying a Credential, the OIDC client initiates the request expecting a standard OIDC ID Token, however as the Mobile Wallet provides the Credential to the platform in JSON-LD terms, the Platform translates the claims from the Verifiable Credential into standard OpenID Connect claims.

Add Claim Mappings

New mappings can be added as follows.

Add a Claim Mapping by providing a payload:

POST https://tenant.platform.mattr.global/v1/oauth/federated/claims

Request

{
"fqnJsonLd": "http://schema.org/educationalCredentialAwarded",
"jsonLdContext": "https://schema.org",
"jsonLdType": "Course",
"jsonLdTerm": "educationalCredentialAwarded",
"oidcTerm": "https://tenant.platform.mattr.global/educationalCredentialAwarded"
}

The fqnJsonLd attributes is the fully qualified JSON-LD claim.

jsonLdContext is the JSON-LD schema, like https://schema.org.

The jsonLdType attribute defines the Credential Type the claim is related to.

jsonLdTerm is the JSON-LD claim name.

oidcTerm is the OIDC claim name.

When adding new Claim Mappings, ensure that the oidcTerm and jsonLdTerm are unique and haven't already been defined in another mapping.

Understanding Schemas

Currently the platform only supports schema.org for data vocabularies.

The entire list of JSON-LD terms can be accessed directly and used to look-up the exact @id to use in the fqnJsonLd claim mappings. In particular note the http protocol vs https.

If you are interested in further vocabularies then please let us know to take into consideration for the future roadmap.

Default Claim Mappings

Default mappings are already provided so that that there's no need to add mappings for common OIDC claims.

The following OIDC claims map to the fully qualified JSON-LD claims by default: