REST API
POST /prove
Generate Web Proof
Under Development: This API is currently in development. Documentation and endpoints may change. For production use, please contact our team.
POST /api/v0/prove
Generate a cryptographic web proof by making a notarized HTTP request to the specified URL.
Request Body
url
: HTTPS URL to make a request to and generate a proof for. Only HTTPS URLs are supportedmethod
: HTTP method to use for the request. Defaults toGET
headers
: Array of HTTP headers formatted as"Header-Name: Header-Value"
body
: Request body data for POST requests as a stringnotaryUrl
: URL of the notary server for TLS notarization. Defaults to vlayer's test notary servermaxSentData
: Maximum data that can be sent in bytes. Defaults to 4096, minimum 1024maxRecvData
: Maximum data that can be received in bytes. Defaults to 16384, minimum 1024async
: Enable asynchronous processing. Defaults tofalse
Response Body
status
: Current status of the proof generation ("completed"
,"pending"
,"failed"
)id
: Unique identifier for the proof generation jobpresentation
: Contains the complete cryptographic web proof (only whenstatus: "completed"
)presentationJson
: Cryptographic proof data for independent verificationdata
: Hex-encoded proof datameta
: Metadata about the notary service and verification process
GET /api/v0/prove/{id}
Poll the status of an asynchronous proof generation job.
Path Parameters
id
The unique identifier returned from a previous asynchronous /api/v0/prove
request.
Response
Returns the same response format as the POST /api/v0/prove
endpoint, with updated status
and proof data when available.