Skip to content
Last updated

Proof types JSON format

The /json/proofTypes.json file in your package lists the JSON proof types that your custom app exposes.

This file must contain a single JSON object. Each property in the object represents a proof type that should be available to users.

The name of each property must match the corresponding JSON proof file within /json/proof. For example, if you define a proof type file named groupMembershipList.json, your proofTypes.json should include a property called groupMembershipList.

Each property’s value is an object that defines metadata for that proof type. At a minimum, this object must include a label property—the human-readable name displayed to users in the Proof Type field.

You can also include optional properties:

  • category — Associates the proof type with a specific proof category selected by the user. See Criteria fields JSON format for more information.
  • schemaCategory — Required if the Hypersync will be used in the Access Reviews module.

Example

{
    "$schema": "https://cdn.jsdelivr.net/gh/Hyperproof/hypersync-sdk/schema/proofProviders.schema.json",
    "groupMembershipList": {
        "label": "{{messages.PROOF_TYPE_MEMBERSHIP_LIST}}",
        "category": "users"
    },
    "userList": {
        "label": "{{messages.PROOF_TYPE_USER_LIST}}",
        "category": "users"
    },
    "deviceList": {
        "label": "{{messages.PROOF_TYPE_DEVICE_LIST}}",
        "category": "devices"
    },
    "listOfUsersApplication": {
        "label": "{{messages.PROOF_TYPE_USER_LIST}}",
        "schemaCategory": "uarApplication"
    }   
}