Passing a Request ID for all service calls

Since finAPI version v1.7.0 you can pass a request ID with any finAPI service call that you make. The request ID is to be passed as a header with name "X-REQUEST-ID".

  • You can use this header for any request to finAPI, and pass an arbitrary string (max length: 255 characters):
  • This string will be returned in the response from a service in case it returns with an error (the error response will contain the field "requestId" in this case):
  • Note that when you don't pass a request id for a call, finAPI will generate a random id internally. Example:

  • Also note that this request ID cannot be set in the Swagger interface, as there is no way to set headers in swagger. If you want to try this out, you have to use a HTTP client like Postman or DHC.

We highly recommend that you always set this request ID, and include it into your client application logs in case of an error. finAPI also logs this request ID in its own logs. This way, support cases can be processed more efficiently, because both you and us have a unique request ID that appears in both our logs and which helps us quickly find out the causes of errors.


Article is closed for comments.
Powered by Zendesk