Authentication

Use this documentation to integrate the Nerotix (eKYC) verification system into your application. All endpoints return structured JSON responses and appropriate HTTP status codes.

Authentication

The Nerotix API uses token-based authentication. Every authenticated API request must include a valid Bearer token in the Authorization header.

Headers

The following headers are required when making authenticated API requests.

Key Value Required
Content-Type application/json Yes
Authorization Bearer <token> Yes
Required Headers
Content-Type
Content-Type: application/json
Authorization
Authorization: Bearer <your_token>
Bearer Token

Pass the authentication token using the Authorization header with the Bearer authentication scheme.

Authorization Header
Authorization: Bearer <your_token>
Token Example

The following is an example of the token structure expected by the API. Use the token issued for your application when making actual API requests.

Example Token
{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>"
}
Complete Header Example
HTTP Headers
Content-Type: application/json
Authorization: Bearer <your_token>
Example Request

An authenticated request should include both the Content-Type and Authorization headers.

Request
POST /api/v1/example HTTP/1.1
Host: api.nerotix.in
Content-Type: application/json
Authorization: Bearer <your_token>
Authentication Errors

If the Authorization header is missing, invalid, expired, or does not contain a valid Bearer token, the API may return an appropriate HTTP error response.

API Response Status Codes

Nerotix API endpoints return appropriate HTTP status codes to indicate whether a request was successful or encountered an error.

Status Code Description
200 Request completed successfully.
400 Bad request or invalid request parameters.
401 Authentication failed or the provided token is invalid or expired.
403 The authenticated user does not have permission to access the requested resource.
404 The requested endpoint or resource was not found.
422 The request was understood but contains validation errors.
500 An unexpected server-side error occurred.