Authentication

Description

API Key Authentication is a security mechanism used to authenticate requests to the survey API. An API key is a unique identifier that is passed along with each request to verify the identity of the client and grant access to the API resources. This method ensures that only authorized users can interact with the API endpoints.

How to Obtain an API Key:

Please contact our team to obtain the API Key

Usage

The API key must be included in the request headers for each API call.

x-api-key: {your_api_key}

Example Request: Here’s how you would include the API key in a request to check respondent availability:

GET {{baseUrl}}/api/user/respondent/availability HTTP/1.1
x-api-Key: abcdef1234567890
Content-Type: application/json

Error Response

{
    "success": false,
    "traceId": "string",
    "error": {
        "code": "UNAUTHORIZED",
        "message": "Your request is unauthorized. Please ensure you have the correct credentials and try again.",
        "errors": []
    },
    "metadata": {},
    "result": {}
}