{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Proof types JSON format","description":"Hyperproof developer resources for custom integrations.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"proof-types-json-format","__idx":0},"children":["Proof types JSON format"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/json/proofTypes.json"]}," file in your package lists the JSON proof types that your custom app exposes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This file must contain a single JSON object. Each property in the object represents a proof type that should be available to users."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The name of each property must match the corresponding JSON proof file within ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/json/proof"]},". For example, if you define a proof type file named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupMembershipList.json"]},", your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["proofTypes.json"]}," should include a property called ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["groupMembershipList"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each property’s value is an object that defines metadata for that proof type. At a minimum, this object must include a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label"]}," property—the human-readable name displayed to users in the Proof Type field."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can also include optional properties:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["category"]}," — Associates the proof type with a specific proof category selected by the user. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/hypersync-sdk/doc/053-criteria-fields-json"},"children":["Criteria fields JSON format"]}," for more information."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["schemaCategory"]}," — Required if the Hypersync will be used in the Access Reviews module."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example","__idx":1},"children":["Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"{\n    \"$schema\": \"https://cdn.jsdelivr.net/gh/Hyperproof/hypersync-sdk/schema/proofProviders.schema.json\",\n    \"groupMembershipList\": {\n        \"label\": \"{{messages.PROOF_TYPE_MEMBERSHIP_LIST}}\",\n        \"category\": \"users\"\n    },\n    \"userList\": {\n        \"label\": \"{{messages.PROOF_TYPE_USER_LIST}}\",\n        \"category\": \"users\"\n    },\n    \"deviceList\": {\n        \"label\": \"{{messages.PROOF_TYPE_DEVICE_LIST}}\",\n        \"category\": \"devices\"\n    },\n    \"listOfUsersApplication\": {\n        \"label\": \"{{messages.PROOF_TYPE_USER_LIST}}\",\n        \"schemaCategory\": \"uarApplication\"\n    }   \n}\n"},"children":[]}]},"headings":[{"value":"Proof types JSON format","id":"proof-types-json-format","depth":1},{"value":"Example","id":"example","depth":2}],"frontmatter":{"seo":{"title":"Proof types JSON format"}},"lastModified":"2026-02-26T22:35:50.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/hypersync-sdk/doc/054-proof-types-json","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}