vlayer docs
REST API

GET /guest-id

Under Development: This API is currently in development. Documentation and endpoints may change. For production use, please contact our team.

GET /api/v0/guest-id

Retrieve the ID of RISC Zero guest program used by the ZK Prover Server to generate ZK Proof in /compress-web-proof. This image ID is required for on-chain verification of ZK proofs generated by the server.

Request

No request body or query parameters required.

Response Body

  • success: Boolean indicating the request was successful
  • data: Object containing guest information
    • guestId: Hex-encoded RISC Zero guest image ID (with 0x prefix)

Example

Retrieve the current guest ID:

curl -X GET https://zk-prover.vlayer.xyz/api/v0/guest-id \
  -H "x-client-id: 4f028e97-b7c7-4a81-ade2-6b1a2917380c" \
  -H "Authorization: Bearer jUWXi1pVUoTHgc7MOgh5X0zMR12MHtAhtjVgMc2DM3B3Uc8WEGQAEix83VwZ"

The included credentials are for limited public use. For production use, please contact our team.

Response:

{
  "success": true,
  "data": {
    "guestId": "0x6a555e28e0d59c20ad0dc76dfa07328f2f68638827dafef87178b306fb02e608"
  }
}