Skip to main content
Age Verification

Read age verification extension

GET/v4/config/platform/extension/age-verification

Reads the configuration of the Age Verification extension: the presentation definition that it uses, the credentials that a wallet can present, and the age limits that the request asks for.

Send verification requests with presentationDefinitionId (OpenID4VC API, verifier). The extension keeps this system-managed presentation definition up to date when you change the credentials or the age limits.

The answer is 404 when the extension is not enabled, also while it waits for its signing key (awaitingKey). Turn it on first with PUT /v4/config/platform/extension/ageVerification and a signingKeyId.

Authorizations

  • Authorizationstringheaderrequired

    Your API key with the prefix ApiKey: ApiKey <your-api-key>. Get an API key.

    Scope:extensions:read

Response

application/json

The configuration of the extension.

  • extensionStatusboolean

    Always true in this answer. An extension that is not enabled gives 404.

  • presentationDefinitionIdstring<uuid>

    The system-managed presentation definition of the extension. Send verification requests with it.

  • labelstring

    The label of the presentation definition.

  • identityCredentialsobject[]

    The credentials that a wallet can present to prove the age. One of the enabled credentials is enough.

  • ageLimitsobject[]

    The age limits that the request asks for. They apply to the Photo ID (isOver18 only) and to the age verification credential. With no limit set, the request asks the age verification credential for age_over_18 only (the one age-over claim that each such credential has), and the Photo ID for the birth date.