Interface AdditionalQueryParams

interface AdditionalQueryParams {
    claimId?: string;
    expectAttestations?: boolean;
    expectVerifySuccess?: boolean;
    hideIfAlreadyClaimed?: boolean;
}

Hierarchy (View Summary)

Properties

claimId? expectAttestations? expectVerifySuccess? hideIfAlreadyClaimed?

Properties

OptionalclaimId

claimId?: string

We will display this claim on the authorize screen. Just for display purpses. This is still to be checked by you post-authentication.

OptionalexpectAttestations

expectAttestations?: boolean

We will expect the user to provide attestations. Consider adding an additional instructions to the user for which ones to present. You still need to check the attestations on your side.

Deprecated

It is preferred to receive attestations via claims instead.

OptionalexpectVerifySuccess

expectVerifySuccess?: boolean

We will expect the claim verification to succeed. If false, we will not let user attempt to sign in.

Note: This is not a replacement for checking the claim on your side because users can manipulate the client-side URL parameters.

OptionalhideIfAlreadyClaimed

hideIfAlreadyClaimed?: boolean

For the claimId, we will hide the claim if the user has already completed it (successCount >= 1).

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR