vlayer docs
REST API

GET /guest-id

Retrieve RISC Zero guest program ID (v2)

GET /api/v2.0/evm/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.

Authentication

Requests require header:

  • Authorization: Bearer <token> — your API secret

Request

No request body or query parameters required.

Response Body

Success

{
  "apiVersion": "v2.0",
  "success": true,
  "data": {
    "guestId": "0x6a555e28e0d59c20ad0dc76dfa07328f2f68638827dafef87178b306fb02e608"
  }
}
  • apiVersion: API version string
  • success: true
  • data.guestId: Hex-encoded RISC Zero guest image ID (with 0x prefix)

Error

{
  "apiVersion": "v2.0",
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Missing or invalid Authorization header"
  }
}

Example

curl -X GET https://zk-prover.vlayer.xyz/api/v2.0/evm/guest-id \
  -H "Authorization: Bearer <your-api-key>"
const response = await fetch('https://zk-prover.vlayer.xyz/api/v2.0/evm/guest-id', {
  headers: {
    'Authorization': 'Bearer <your-api-key>'
  }
});

const result = await response.json();
console.log(result.data.guestId);

Response:

{
  "apiVersion": "v2.0",
  "success": true,
  "data": {
    "guestId": "0x6a555e28e0d59c20ad0dc76dfa07328f2f68638827dafef87178b306fb02e608"
  }
}