Claim Sets

Request specific mDL claims using predefined sets or custom claim configurations.

Predefined Claim Sets

The SDK provides predefined claim sets for common verification scenarios. Use these for quick integration while following privacy best practices:

Claim Set	Description	Claims Included
`'age_over_18'`	Age verification (18+)	age_over_18
`'age_over_21'`	Age verification (21+)	age_over_21
`'age_over_25'`	Age verification (25+)	age_over_25
`'identity_basic'`	Basic identity info	given_name, family_name, birth_date
`'identity_full'`	Full identity	All name fields, birth_date, portrait, document_number
`'driving_privileges'`	License categories	driving_privileges, issue_date, expiry_date
`'address'`	Address verification	resident_address, resident_city, resident_state, resident_postal_code

Using Predefined Sets

Custom Claim Requests

Request specific claims using an array of claim names:

Available Claims

The following claims are available from ISO 18013-5 mDL credentials. Not all issuers include all claims:

Personal Information

Claim	Type	Description
`family_name`	string	Last name / surname
`given_name`	string	First name
`birth_date`	string (date)	Date of birth (YYYY-MM-DD)
`birth_place`	string	Place of birth
`portrait`	binary	Photo (JPEG or PNG)
`sex`	number	Sex (ISO 5218)
`height`	number	Height in cm
`weight`	number	Weight in kg
`eye_colour`	string	Eye color
`hair_colour`	string	Hair color
`nationality`	string	Nationality (ISO 3166-1)

Age Claims

Claim	Type	Description
`age_over_18`	boolean	Is 18 or older
`age_over_21`	boolean	Is 21 or older
`age_over_25`	boolean	Is 25 or older
`age_in_years`	number	Current age in years
`age_birth_year`	number	Birth year

Address Claims

Claim	Type	Description
`resident_address`	string	Street address
`resident_city`	string	City
`resident_state`	string	State/Province
`resident_postal_code`	string	Postal/ZIP code
`resident_country`	string	Country code

Document Claims

Claim	Type	Description
`document_number`	string	License number
`issue_date`	string (date)	Issue date
`expiry_date`	string (date)	Expiration date
`issuing_authority`	string	Issuing authority
`issuing_country`	string	Issuing country
`issuing_jurisdiction`	string	Issuing state/province
`driving_privileges`	array	Vehicle categories

Accessing Claim Values

Privacy Best Practices

Minimal disclosure: Only request claims you actually need
Use age claims: Prefer age_over_21 over birth_date when possible
Avoid portrait: Don't request portrait unless necessary for face matching
Clear purpose: Provide a clear verificationPurpose to build user trust

Example: For alcohol age verification, use 'age_over_21' instead of'identity_full'. This respects user privacy while meeting your verification needs.