Documentation/Studio
Back
  • Getting started
    • Key concepts
    • Sign in
    • Create and switch organisations
  • Registers
    • Create and change a register
    • Upload and download entries
    • Add, edit and deactivate entries
    • Groups
    • Claims
    • Challenge codes
    • Connect and test an external register
    • Register activity
  • Membership definition
    • Add and order register assignments
    • Filters and outcomes
    • Preview before saving
    • Save and version history
  • Member code query
  • Members directory
    • Find a member
    • Look up the checks of a member code
    • Deactivate a membership
  • Communities
    • Create, rename and delete a community
    • Filter by register, status, groups and claims
  • Frontends
    • Create a frontend
    • Frontend keys
    • Released claims
    • Sign-in settings
    • Sign-in branding
  • Login with appsolut
    • Sign-up and onboarding
    • Sign-in and sign-out
    • Support requests
  • Frontend users
    • Find a frontend user
    • Membership and activations
    • Block a frontend user
    • Export a frontend user's data
    • Disconnect a frontend
  • Membership check
    • Check modes
    • Results and the check log
    • Rate limits
    • Grace rule
  • Organisation settings
    • Organisation profile
    • Studio users and roles
    • Billing
    • Roadmap and feature requests

Released claims

Choose which claims a frontend's backend may read about its signed-in members and eligible applicants.

Studio roles: "Owner", "Administrator" and "Frontend manager".

A claim is a fact a register holds about a member beyond the person data, such as their employee group, whether their annual salary is above 50k, or their number of children. An external register gives the claims of the appsolut register API and its own; an internal register holds the claims you declare for it, see Claims. A frontend's backend can read the claims of its signed-in member from the Studio, and those of an applicant whose eligibility it checks once the applicant is eligible, for example to price a travel offer for them. It reads them live from the member's register, and only the claims you have released to that frontend.

A released claim is also answered to the frontend's backend when it asks whether someone is eligible: for anyone whose member code, names and birth date it sends, if they match and the person is eligible, whether or not that person has ever signed in. Claims can hold sensitive data, so a new frontend has none released. Release only the claims a frontend needs, and only to the frontends that need them: each frontend has its own list.

Release claims

  1. Open "Frontends" and choose the frontend.
  2. Under "Released claims", tick the claims under "Claims of the appsolut register API" that the frontend needs.
  3. For a claim of your own register, type its key under "Your organisation's own claims", exactly as the register names it, and press Enter. The key is matched exactly, capital letters included.
  4. Choose "Save released claims".

From its next request on, the frontend's backend gets the released claims the member's register gives. A released claim the register does not hold for a member is left out of the answer.

Withdraw claims

  1. Under "Released claims", untick the claim, or choose the cross next to your own claim's key.
  2. Choose "Save released claims".

The frontend's backend no longer gets the claim from its next request on. Every release and withdrawal is recorded with who made it.

If another user has changed the released claims since you opened the page, your changes are not saved, so you never release again a claim they have just withdrawn. Choose "Reload page", then make your changes again.

What a frontend never gets

  • A claim you have not released to it.
  • Claims in the sign-in tokens.
  • Claims of a member whose membership is not valid, or of an applicant who is not eligible: whether someone is eligible, and the answer when they are not, never depend on what you release.
  • Claims in the check log: an eligibility check never records them.

How the frontend's developers read the claims is in the developer documentation: The signed-in member.