What to send on an incident ticket for the Data API?

Our Help Centre and official Documentation pages can be a huge help if you are integrating, testing our APIs or facing issues. However, fear not: we are also here to assist you!

In order to provide the best support we can, we would like as many details as possible of the situation you are facing. Have a look below at the best practices for sending your support ticket.

Must haves

Here are the requirements for your incident ticket

1. Your Live environment client_id: you can find this under Settings in your Console
2. The closest possible time and date for when the issue happened (in GMT)
3. Error message
4. Steps to replicate the issue - or what you were trying to do when it happened. Include here the endpoint you called, parameters, etc.
5. Device and browser used
6. task_idfor asynchronous and Batch endpoint requests
7. If authentication is unsuccessful: session_ids for the users affected. Here's how to get a session_id
8. If authentication has been successful: debug_ids and credentials_idsfor the accounts affected. Here's how you submit an access token for debugging (please follow the same format as shown in the instructions)

Nice to haves

The below are not mandatory but can definitely help:

1. Screenshots and/or screen-recorcordings, where relevant. Important: blur or cut out any piece of sensitive information.
2. The X-Request-Id, if available. It looks like this: c39df0fb-a684-447c-9fbc-3f24c288f608

⚠️ Do not send ⚠️

1. Any kind of end-user sensitive information such as sort codes, account numbers, IBANs, passwords or PINs.
2. Any access_tokens. They are exclusively yours! We only ask for debug_id.
3. Your client_secret.
4. Screenshots or video recordings containing end-users information such as the ones on point #1 or balance, etc.
5. refresh_token if the issue is related to refreshing. 

Any sensitive information shared through our ticketing system channel represents a security threat.

Steps to follow

To send your incident request, simply go to our Support Portal and select "Submit a request" on the top-right of the screen. That's it!