TT® REST API

Risk Documentation

The Risk service of the TT REST API is used for requests pertaining to managing users and accounts to check limits, permissions and monitor risk.

Requests to the Risk service of the TT REST API use the following base URL: apigateway.trade.tt/risk/<environment>:

  • https://apigateway.trade.tt/risk/ext_uat_cert for application development and testing
  • https://apigateway.trade.tt/risk/ext_prod_live for deploying an application to production

Limitations for POST requests

For POST endpoints which allow for the submission of a list of items, the number of list items must not exceed twenty. Furthermore, a one-second pause must be initiated after the acknowledgement from a prior POST submission has been received. Most daily maintenance and activity will not be affected by these limits and can be accomplished normally on weekdays.

Activities that involve uploading significant amounts of data, such adding large numbers of users or starting a migration, will require special scheduling. In such circumstances, please contact TT Onboarding with scheduling assistance.

Access Parameters

Calls to the Risk services listed below require both of the following in your header:

  • Application Key
    • x-api-key=<application key>
  • Token
    • Authorization=Bearer <token>

For instructions on obtaining your application key and token, refer to the Getting Started article in the TT REST Web Services documentation.

Test calls

To test the calls below, click the Authorize button and enter values for both access parameters into the Authorizations Menu.

Note: When entering your token you will need to manually concatenate "Bearer" and a single space in front of the token value sent by TTID.

All test calls sent through this help site use the following base URL:

https://apigateway.trade.tt/risk/ext_uat_cert