v14

latestOpenAPI 3.0.3raw.githubusercontent.com2023-06-27173980.4 KB

This endpoint is to check your API request and test if it is working by authenticating the user.

post/authentication

Response

OK

statusstring

Status of the authentication process.

messagestring

A message regarding the authentication status.

organization_namestring

The name of the authenticated organization.

user_namestring

The name of the authenticated user.

user_emailstring email

The email of the authenticated user.

timestampinteger

The timestamp when the authentication request was processed.

idstring

The Request ID associated with the authentication process.

Example response

{
  "status": "success",
  "message": "User Authenticated Successfully",
  "organization_name": "Sample Organization Inc.",
  "user_name": "John Doe",
  "user_email": "john@worqhat.com",
  "timestamp": 1687753142003,
  "id": "a1146b58-a6fd-46a1-944c-3b1aad50d14b"
}
All 17 operations