API Reference
The Account Recovery Relayer API provides endpoints for managing account recovery and acceptance processes through email-based verification.
Echo
Request Parameters
No parameters required.
Response Fields
message (string)
A simple greeting message returned by the API.
Endpoint
GET https://auth-base-sepolia-staging.prove.email/api/echo
Request
Response
(Example){
"response": "Hello, world!"
}
Request Status
Request Parameters
request_id (number)
Unique identifier for the request to check status.
Response Fields
request_id (number)
The ID of the request being checked.
status (string)
Current status of the request. Possible value: "Pending".
is_success (boolean)
Whether the request has been successfully processed.
email_nullifier (string | null)
Nullifier value for the email, if available.
account_salt (string)
The salt value used for account creation, in hex format.
Endpoint
POST https://auth-base-sepolia-staging.prove.email/api/requestStatus
Request
Response
(Example){
"request_id": 3641160587,
"status": "Pending",
"is_success": false,
"email_nullifier": "null",
"account_salt": "0x18bd7926ed1e2b026aafb3a7c540ff2af37733f8c12005a36e565ba99a9a091e"
}
Acceptance Request
Request Parameters
controller_eth_addr (string)
Ethereum address of the controller initiating the acceptance.
guardian_email_addr (string)
Email address of the guardian involved in the acceptance process.
account_code (string)
Unique code associated with the account.
template_idx (number)
Index of the template to use for the acceptance command.
command (string)
The command to execute, specifying old and new owner addresses.
Response Fields
request_id (number)
Unique identifier for the acceptance request.
command_params (array)
Array of command parameters used in the request.
Endpoint
POST https://auth-base-sepolia-staging.prove.email/api/acceptanceRequest
Request
Response
(Example){
"request_id": 12345,
"command_params": [{"type":"string","value":"example_param"}]
}
Recovery Request
Request Parameters
controller_eth_addr (string)
Ethereum address of the controller initiating the recovery.
guardian_email_addr (string)
Email address of the guardian involved in the recovery process.
template_idx (number)
Index of the template to use for the recovery command.
command (string)
The command to execute for account recovery, specifying old and new owner addresses.
Response Fields
request_id (string)
Unique identifier for the recovery request.
subject_params (object)
Contains parameters related to the subject of the request, such as account_eth_addr.
status (string)
The status of the recovery request. Possible value: "success".
Endpoint
POST https://auth-base-sepolia-staging.prove.email/api/recoveryRequest
Request
Response
(Example){
"request_id": "fecfac34-3333-4cd3-bdaa-1b349aea0699",
"subject_params": {"account_eth_addr":"0x..."},
"status": "success"
}
Complete Recovery Request
Request Parameters
account_eth_addr (string)
Ethereum address of the account being recovered.
controller_eth_addr (string)
Ethereum address of the controller completing the recovery.
complete_calldata (string)
Encoded calldata for completing the recovery transaction.
Response Fields
message (string)
A message indicating the recovery completion status.
Endpoint
POST https://auth-base-sepolia-staging.prove.email/api/completeRequest
Request
Response
(Example){
"message": "Recovery completed"
}
Get Account Salt Request
Request Parameters
account_code (string)
The unique code used to generate the account salt. A random number in the BN254 curve.
email_addr (string)
Email address associated with the account.
Response Fields
account_salt (string)
The generated account salt in hex format.
Endpoint
POST https://auth-base-sepolia-staging.prove.email/api/getAccountSalt
Request
Response
(Example){
"account_salt": "0xabcdef1234567890..."
}