Verify Auth Token
This endpoint verifies the validity of an authorization token or credentials for an ENTERPRISE_API user type. It is typically used to confirm that a user's token is still valid and to determine their authentication status.
HTTP Method & URL
Method: POST
URL: {{host}}/api/v2/auth/verify?user_type=ENTERPRISE_API
Authentication
-
Requires a valid Bearer token in the Authorization header.
-
plaintextAuthorization: Bearer
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| user_type | string | Yes | Must be set to ENTERPRISE_API |
Request Body
-
Content-Type:
application/json -
json{ "org_invite_code": "9K5C01GPEW"}
Example Request
httpPOST {{host}}/api/v2/auth/verify? user_type=ENTERPRISE_APIAuthorization: Bearer <user-token>Content-Type: application/json{ "org_invite_code": "9K5C01GPEW"}
Successful Response
-
Status: 200 OK
-
Content-Type: application/json
json{ "message": "Token is valid.", "data": { "redirect_to": "", "status": "active" }}
Error Responses
-
401 Unauthorized: Missing or invalid token.
-
400 Bad Request: Invalid parameters or missing required fields.
Usage Notes
-
The endpoint checks the validity of the provided token. If the token is invalid or expired, an error response will be returned.
-
The response includes a message and a data object. The data object may contain a redirect URL and the user's authentication status.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
