Skip to main content

API Reference

Explanation of the API.

Echo​

Request Parameters​

Response Fields​

Endpoint​

GET https://auth-base-sepolia-staging.prove.email/api/echo

Request


Response

(Example)
{
  "response": "Hello, world!"
}

Request Status​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/requestStatus

Request

Edit Request

Response

(Example)
{
  "request_id": 12345,
  "status": 1,
  "is_success": false,
  "email_nullifier": "0x1234...",
  "account_salt": "0xabcd..."
}

Acceptance Request​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/acceptanceRequest

Request

Edit Request

Response

(Example)
{
  "request_id": 12345,
  "status": 1,
  "is_success": false,
  "email_nullifier": "0x1234...",
  "account_salt": "0xabcd..."
}

Recovery Request​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/recoveryRequest

Request

Edit Request

Response

(Example)
{
  "request_id": "fecfac34-3333-4cd3-bdaa-1b349aea0699",
  "subject_params": {"account_eth_addr":"0x..."},
  "status": "success"
}

Recovery Request​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/recoveryRequest

Request

Edit Request

Response

(Example)
{
  "request_id": "fecfac34-3333-4cd3-bdaa-1b349aea0699",
  "subject_params": {"account_eth_addr":"0x..."},
  "status": "success"
}

Complete Recovery Request​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/recoveryRequest

Request

Edit Request

Response

(Example)
{
  "status": "success",
  "message": "Recovery completed successfully."
}

Get Account Salt Request​

Request Parameters​

Response Fields​

Endpoint​

POST https://relayer.zk.email/api/getAccountSalt

Request

Edit Request

Response

(Example)
{
  "account_salt": "0xabcdef1234567890..."
}