Getting API access

Choosing the URL

The following table displays the base URL you need to use depending on the environment your token is deployed on:

Depending on the module you wish to call, you need to suffix with:

cURL request

To leverage the T-REX Servicing API, you will first need to retrieve an authentication token that will allow you to perform any operation. As our APIs are role based, you will need to make sure to have an authentication token corresponding to an account with the proper rights to call it. Please refer to our guide on permissions and roles. For example, an agent account will not be able to call investor endpoints.

For the Servicing API, in the testing environment, call the following signin endpoint:

curl --request POST \
  --url https://api-testing.tokeny.com/servicing/api/auth/signin \
  --header 'Content-Type: application/json' \
  --data '{"email":"[email protected]","password":"MyP@$$word"}'

Response

{
    "token": "<jwt>"
}

Possible error codes

HTTP400 Bad request: there is a validation error, see Managing validation errors in body requests section.
HTTP401 Unauthorized: email or password is wrong.