Authentication

Authentication is a complex subject and there is multiple scenarios how the the request may not return expected 200 OK response with the valid token.

The OAuth2 token endpoint will return a 400 Bad Request error if an application lacks the necessary permissions or if the access token request is misconfigured. You can use the error details in the response body to identify the root cause of the issue. Below is a compilation of common error responses and methods for resolving them.

invalid_request

A required parameter is missing from the request. grant_type, client_id, and client_secret must be supplied.

invalid_client

Verify that the client ID and secret values provided are accurate.

invalid_scope

Make sure the scope environment you are using is accurate, for example, "preprod-api" vs. "prod-api".

invalid_grant

The application does not have the scope that you have requested. Kindly get in touch with your business contact.

unsupported_grant_type

Invalid grant_type value was requested. Use client_credentials grant type.

Empty Collection

Empty Collection vs 404 Not Found response

An empty collection with IsLastPage:true is returned when the filter query returns no results when accessing API endpoints that support pagination and filtering.

A 404 Not Found error is in turn returned when a non-existent page is requested. For example, sending a request to retrieve page 2 from the GET /accounts endpoint when page 1 was tagged as the final page would generate a 404 Not Found response.