Make a test API call for authentication

To check that you can use your API keys successfully, try making a call with each key to see if you get responses without errors. The API has a timeout of 60 seconds.

In the header of each request you make, include a parameter called apikey with the value of the key you want to test.

For example: "apikey": "adc5788e3b7fecc161d2a36916750ee10480a8c75841bd"

This example is not a real API key, so it's not possible to use it to make calls.

To run your test, make the call to the following endpoint once per key. The call returns the name of your API key and your institution.

Request endpoint:

GET https://api.passfort.com/4.0/whoami

Sample response:

{
    "auditee_name": "Forexo Ltd Master API Key",
    "institution": {
        "id": "6bba3592-d9de-1ee5-8e97-ba8d8d13c558",
        "logo_url": null,
        "name": "Forexo Ltd"
    },
    "user": null
}

If you received a response with the API key name as the value for auditee_name, the test worked.

If you received an error message, check that you're sending a valid API key in the header of your request, and try again.