Provers
List Provers
List Provers
GET
https://privacy.provide.services/api/v1/provers
Returns a list of
Prover
instances in the authorized scope
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Create Prover
Create Prover
POST
https://privacy.provide.services/api/v1/provers
Creates a Prover using the given parameters
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Request Body
Name | Type | Description |
---|---|---|
curve | string | pairing-friendly elliptic curve |
identifier | string | prover identifier; i.e.
|
name | string | name of
to be created |
provider | string | prover provider, i.e.,
|
proving_scheme | string | proving scheme to be used; i.e.,
|
type | string | type of prover |
Retrieve Prover Details
Get Prover Details
GET
https://privacy.provide.services/api/v1/provers/:id
Returns detailed information for a specified
Prover
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id of target
|
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Retrieve Note Value
Get Note Value
GET
https://privacy.provide.servies/api/v1/provers/:id/notes/:index
Returns the note store value of the specified
Prover
; the response contains the decrypted note
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id of target
|
index | string | index of the leaf in the merkle tree for the underlying data structure |
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Retrieve Nullifier Value
Get Nullifier Value
GET
https://privacy.provide.services/api/v1/provers/:id/nullifiers/:index
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id of the prover |
index | string |
Generate Proof
Generate Proof
POST
https://privacy.provide.services/api/v1/provers/:id/prove
Once you have provisioned a prover, this API can be used to generate a proof given valid witness parameters. Calling this API has an implicit side-effect of writing the hash of generated proof to the persistent store associated with the
Prover
.
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id of
requiring proof |
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Request Body
Name | Type | Description |
---|---|---|
witness | object | Public and private inputs used to generate the
. Payload can be delivered as a JSON object or chunked and streamed. |
Verify Proof
Verify Proof
POST
https://privacy.provide.services/api/v1/provers/:id/verify
Verifies a
Proof
using the given
Witness
parameters
Path Parameters
Name | Type | Description |
---|---|---|
id | string | id of
to be verified |
Headers
Name | Type | Description |
---|---|---|
authorization | string | bearer scoped to an
|
Request Body
Name | Type | Description |
---|---|---|
proof | string | the hex-formatted proof to verify |
store | boolean | when true, the verified note is written to the configured store and the nullified note is written to the nullifier store, if applicable |
witness | object | public and private inputs used to generate the
. Payload can be delivered as a JSON object or chunked and streamed. |
Last updated