Check your authentication token

Get information about the user logged in with a specific session token, such as user details, user type or language preferences.

For security reasons, you need to perform a Login action before making any other public calls to the WorldServer API. The sessionId in the response is your session token. Use this token in all the other calls that you make.

Also, make sure that you have the appropriate user type permissions to perform this API call. To view or update your permissions, in WorldServer, go to Management > User Setup > User Types, and then select your user type.

API call

<protocol>://<ws-host>:<ws-port>/ws-api/v2/login/checkToken?token=<sessionId>

Details

  • POST method
  • Content-Type in the header: application/json
  • Mandatory parameter: the session token (as a query string parameter or as a key-value pair in the header)

Response

A screen shot that shows a typical response to this call.

Error messages

MessageStatus code
No session token provided or invalid token401 Unauthorized