Quick Start for Creating Custom Schema
Login zkPass dev center and create custom schema
Login in zkPass dev center, create a project and add a schema.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252Fb3yFsgic8djqey20zeyC%252Fimage.png%3Falt%3Dmedia%26token%3D802d3cf6-4f76-48f5-834a-8f359da77a62&width=768&dpr=4&quality=100&sign=4984b53d&sv=1)
Click on "Add Custom Schema". If you haven't installed the zkPass Schema Validator, please click "install" to install the extension first.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252F3cXkIiFj7NBnlpixSkwq%252Fimage.png%3Falt%3Dmedia%26token%3Db0089b24-5fe5-408e-9557-6d0978d685d5&width=768&dpr=4&quality=100&sign=4a45c0f8&sv=1)
Enter the schema name, select the category, paste your custom schema into the JSON schema field, and then click "Check Schema." The website specified in your schema JSON will be opened.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FIwYGXZ8pbi2XP9lfU8Bf%252Fimage.png%3Falt%3Dmedia%26token%3D69ae90f5-d5d0-4133-ab9f-c93162db4c27&width=768&dpr=4&quality=100&sign=8da7340&sv=1)
If the schema validation is successful, you will observe the 'Check Pass' button at the bottom.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FzhvYCW4ye0i74OmMbE8v%252Fimage.png%3Falt%3Dmedia%26token%3D86f0bb54-b4d9-42e0-8dca-ac40cb1aec2b&width=768&dpr=4&quality=100&sign=a16e2105&sv=1)
Upon clicking the 'Check Pass' button, you will be redirected back to the zkPass dev center and presented with a success modal. Then, you can submit your schema.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252F5PutVGWd28DXpYfHblWP%252Fimage.png%3Falt%3Dmedia%26token%3Dba6b634a-56b8-4759-be76-d0584855f92d&width=768&dpr=4&quality=100&sign=10e8cf55&sv=1)
Congratulations, you have successfully generated the schema. You can now seamlessly integrate it into your project.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FULXEPVsLgNMi0apRZLKX%252Fimage.png%3Falt%3Dmedia%26token%3D0d7b0046-655c-43a5-a355-9eefb5b0bad4&width=768&dpr=4&quality=100&sign=7cfdde92&sv=1)
If the schema validation is failed, you will observe the 'Check Error Message' button at the bottom.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FbmxFhfcdmgX5D7XfSYFM%252Fimage.png%3Falt%3Dmedia%26token%3D703deafa-12d8-45ae-8fe3-742c1141828f&width=768&dpr=4&quality=100&sign=dbf2ee93&sv=1)
Upon clicking the 'Check Error Message' button, you will be redirected back to the zkPass dev center and presented with a error modal. Then, you can correct your schema based on error messages.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FIpsEVFvWdPXXotDWsLpC%252Fimage.png%3Falt%3Dmedia%26token%3D64ed4f94-b29f-465f-a5b2-adcad6e0e58a&width=768&dpr=4&quality=100&sign=e979f0f1&sv=1)
Tips for writing a schema json file on Chrome
Open the website you are targeting, navigate to the page containing the desired information, right-click on the page, and choose "inspect."
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FF37FhEIp9hlfMYR2PLA4%252Fimage.png%3Falt%3Dmedia%26token%3D42ce0e96-8be4-4102-bb5d-5941fd3ffe28&width=768&dpr=4&quality=100&sign=dc091c28&sv=1)
Select the "Network" tab, then refresh the page to capture all the HTTP requests. You can use the "Fetch/XHR" tag to filter the RESTful APIs.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252F0aGN5LHH2rK72JXFBFyp%252Fimage.png%3Falt%3Dmedia%26token%3D0d735f70-cd16-4e8c-9dad-1c6ac93875be&width=768&dpr=4&quality=100&sign=462e4847&sv=1)
Locate the APIs that provide the desired information. Click on each of them, then click "Headers" tabs to review the request details to identify the host and intercept for the schema.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252FzMNHuU464muvCRdeSMWp%252Fimage.png%3Falt%3Dmedia%26token%3Dfcbd9ece-a5f0-48f4-a469-c1f2d85cba26&width=768&dpr=4&quality=100&sign=c9e8a10e&sv=1)
Click "Preview" tag to review the response details to identify the assert and nullifier for the schema.
![](https://zkpass.gitbook.io/~gitbook/image?url=https%3A%2F%2F2216484837-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252FC2Jh1oquOpJPfwzD3x9L%252Fuploads%252F5Wwcyus2WQFgC9tYWmB3%252Fimage.png%3Falt%3Dmedia%26token%3Decd1df36-0c47-45a7-8b0b-bcc0a8dd822f&width=768&dpr=4&quality=100&sign=a9db56b2&sv=1)
Last updated