v1

latestOpenAPI 3.0.32026-08-06150495.9 KB

Partner Authentication

Get Initial Access Tokens

Sign In Endpoint

This endpoint is used to authenticate a user and initiate a session by providing the user's credentials. Upon successful authentication, the user receives a token that has a 24-hour expiry and can be used for subsequent requests.

HTTP Method

POST

Request URL

POST {{base-url}}/v1/partnerApi/auth/signin

Request Body

Parameter	Type	Description
email	string	The email address of the user.
password	string	The password for the user.

Example Request Body:

{
  "email": "YourEmail",
  "password": "YourPassword"
}

Response

The response will indicate the success or failure of the authentication attempt.

Response Structure

Parameter	Type	Description
status	boolean	Indicates if the request was successful.
statusCode	integer	Code representing the status of the response.
message	string	A message providing additional information (if any).
result	object	Contains the authentication result.
profile	object	User profile information.
id	string	Unique identifier for the user.
email	string	Email address of the user.
username	string	Username of the user.
token	string	Authentication token for the session (expires in 24 hours).
refresh	string	Refresh token for obtaining a new access token.
error	object	Contains error information if authentication fails.

Example Response:

{
    "status": true,
    "statusCode": 200,
    "message": "User signed-in successfully",
    "result": {
        "profile": {
            "id": "c369fc58-48ecc4d5790db1",
            "email": "email@voosh.in",
            "username": "Chatmeter"
        },
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTM",
        "refresh": "eyJhbGciOjttRc.eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9OiJIUzI1NiIsInR5cCI6IkpXVCJ9"
    },
    "error": null
}

This endpoint allows users to authenticate and sign in to the partner API.

post/v1/partnerApi/auth/signin

Request body

emailstring

passwordstring

Example request

{
  "email": "YourEmail",
  "password": "YourPassword"
}

Response

200

{"stackTrail":"paths:/v1/partnerApi/auth/signin:post:responses:200:content:application/json:schema:properties:error","oasType":"schema","type":"unknown","example":null,"nullable":true}

messagestring

statusboolean

statusCodenumber

Example response

{
  "message": "User signed-in successfully",
  "result": {
    "profile": {
      "email": "email@voosh.in",
      "id": "c369fc58-48ecc4d5790db1",
      "username": "Chatmeter"
    },
    "refresh": "eyJhbGciOjttRI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUc",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzUI6IkpXVCJ9.eyJpZCI6ImMzNjlmYzU4LTM"
  },
  "status": true,
  "statusCode": 200
}