Skip to main content

Login

Logout

Upon completion of this API call, the session will be terminated, rendering the jKey invalid. As a result, the user will be required to log in again to establish a new session and obtain a new access token.

Method: POST​

https://connect-go.thefirstock.tech/api/V5/logout

Request details

API Parameters
Key Value Type Mandatory
userToken abc123 String Yes
userId NP2997 String Yes
type API String Yes

Libraries and SDKs

Tabbed Interface 
curl --location 'https://connect-go.thefirstock.tech/api/V5/logout' \
--header 'Content-Type: application/json' \
--data '{
    "userToken": "ce1c4471eb9588aba98ec5dd566b4c5e72aa7",
    "userId": "NP2007",
    "type": "API"
}'

Success response details

API Parameters
Parameter Description Example
status
String 		Indicates the outcome of the API request success
data
String 		Contains a message confirming successful logout Successfully logged
out		 
{
    "data": "Successfully logged out",
    "status": "Success"
}

Failure response details

API Error Parameters
Parameter Description Example
status
String 		Indicates the result status of the API operation failed
code
String 		HTTP status code associated with the error 401
name
String 		Specifies the type or category of the error encountered INVALID_JKEY
error.field
String 		Field in the request that triggered the error jkey
error.message
String 		Detailed message describing the error jKey parameter is invalid 
{  
  "status": "failed", 
  "code": "401",
  "name": "INVALID_JKEY", 
  "error": {   
  		"field": "jKey", 
    	"message": "jKey parameter is invalid" 
	}
}