POST /api/login

Version: 3.0.0

Url

https://platform.globaltravelrule.com/api/login

The user logs in to obtain the JWT Token and uses it to make api calls. (The login session is Single-sign on: SSO, if you login from other session, current session will be forced logout)

Authentication

No authentication

Path Parameters

No path parameters

Query Parameters

No query parameters

Request Body (Optional)

Schema

	Property	Type	Required	Description
	accessKey	String	Yes	Access key generated through the 'generate API key' operation
	expireInMinutes	Integer	No	The login session will be revoke after the N minutes, leave blank to keep session forever
	signedSecretKey	String	Yes	Secret key generated through the 'generate API key' operation, must be signed with SHA512
	vaspCode	String	Yes	VASP CODE allocated by GTR system

Example

{
  "accessKey": "[access_key] in the csv",
  "expireInMinutes": 0,
  "vaspCode": "string",
  "signedSecretKey": "sha512([secret_key] in the csv)"
}

Responses

Status 200

Login success, user info returned.

JSON Content

Schema

	Property	Type	Description
	data	Object
Property Type Description jwt String Jwt issued by GTR API server vaspCode String VASP code corresponding to the business system
	msg	String	See ResponseMessageEnum
	status	String	See ResponseStatusEnum
	success	Boolean	Request is success or not
	verifyMessage	String	See VerifyStatusEnum
	verifyStatus	Integer	See VerifyStatusEnum

Example

{
  "msg": "string",
  "verifyStatus": 100000,
  "data": {
    "jwt": "string",
    "vaspCode": "string"
  },
  "verifyMessage": "Success",
  "success": true,
  "status": "string"
}