Task Verification API

Orbiter Quest supports any third party to provide a mission verification interface. As long as you follow the interface specifications, your mission can be verified in our Quest.

API Overview

• API Endpoint: /verify/xxxx

• HTTP Method: POST

• Functionality: Verifies whether a user has completed a task.

• Use Case: Third-party projects can use this API to validate user task completion and return the results to the Orbiter platform.

---

Authentication

• Is Authentication Required?: Optional.

• Authentication Method: If authentication is required, provide an API key in the request header in the following format:

  Authorization: Bearer <API_KEY>

---

Request Headers

Header	Required	Description
Content-Type	Yes	The content type of the request body, fixed as application/json.
Authorization	No	API key in the format Bearer <API_KEY>.

---

Request Body

Field Name	Type	Required	Description
input	object	No	External data for verification (e.g., transaction hash txHash or tweet ID tweetId).
address	string	Yes	The user's wallet or account address.

Example Request

POST /v1/verify
Content-Type: application/json
Authorization: Bearer sk_test_abcdef123456

{
  "input": { "txHash": "0xdeadbeef..." },
  "address": "0x1234abcd..."
}

---

Response Body

Field Name	Type	Description
isValid	boolean	Indicates whether the verification passed (true) or failed (false).
message	string	A human-readable result or error message.
result	object	Optional, strategy-specific return data, e.g., { "count": 1 }.

Example Response

{
  "isValid": true,
  "message": "Verification succeeded",
  "result":null
}

---

Error Response

When a request fails, the API will return an error response with the following fields:

Field Name	Type	Description
isValid	boolean	Should be false, indicating the verification failed.
message	string	Detailed error description.
result	object	Optional.

Example Error Response

{
  "isValid": false,
  "message": "The provided txHash is invalid."
}

---

Notes

1. Optional Authentication: If the Authorization header is not provided, the API will determine access based on its configuration.

2. Request Body Validation:

   • The input field must contain valid external data (e.g., txHash or tweetId).

   • The address field must be a valid wallet address.

3. Response Time: The API's response time may vary depending on the complexity of the external data validation.

---

FAQs

1. What happens if the Authorization header is not provided?

• If authentication is required, the API will return a 401 Unauthorized error.

• If authentication is optional, the API will process the request based on default permissions.

2. How should verification failures be handled?

• If isValid is false, use the information in the message field to guide users in correcting their input data.

---

Contact Us

If you encounter any issues while using the API, please contact us via the following channels:

• Email: [e-mail]

• Website: https://orbiter.finance