View investigation by ID

This endpoint allows you to view the details of an ongoing investigation using the supportTicketId.

The API response contains all the messages added by either you and our support team along with any files that are attached to the investigation.

The status of the investigations is also returned in the response. You can have the following 2 statuses for any investigation:

OPEN - Investigation has been created and is assigned to one of our client support team members.
CLOSED - Investigation has been closed by either you or one of our client support team members.

Request

URL: /api/v1/investigation/:supportTicketId

Method: GET

Response

The response will contain details of the investigation for the specified supportTicketId

Example response

When an investigation is OPEN

{
    "supportTicketId": "CS5100280091",
    "createdBy": "John Scott",
    "createdDate": "2025-05-21T11:07:12.066Z",
    "fxId": "1234567",
    "topic": "Modify",
    "reason": "Incorrect Value Date",
    "status": "OPEN",
    "orderingInstitutionName": "First Bank",
    "instructingInstitution": "Aspire Bank Ltd",
    "messages": [
        {
            "createdBy": "John Scott",
            "createdDate": "2025-05-21T11:07:12.066Z",
            "comment": "please look into the transaction",
            "attachments": [],
            "orderingInstitutionName": "First Bank",
            "instructingInstitution": "Aspire Bank Ltd"
        },
        {
            "createdBy": "John Scott",
            "createdDate": "2025-05-21T11:09:11.23Z",
            "comment": "provide an update - refer email",
            "attachments": [],
            "orderingInstitutionName": "First Bank",
            "instructingInstitution": "Aspire Bank Ltd"
        }
    ]
}

When an investigation is CLOSED

{
    "supportTicketId": "CS5100280091",
    "createdBy": "John Scott",
    "createdDate": "2025-05-21T11:07:12.066Z",
    "fxId": "1234567",
    "topic": "Modify",
    "reason": "Incorrect Value Date",
    "status": "CLOSED",
    "orderingInstitutionName": "First Bank",
    "instructingInstitution": "Aspire Bank Ltd",
    "messages": [
        {
            "createdBy": "John Scott",
            "createdDate": "2025-05-21T11:07:12.066Z",
            "comment": "please look into the transaction",
            "attachments": [],
            "orderingInstitutionName": "First Bank",
            "instructingInstitution": "Aspire Bank Ltd"
        },
        {
            "createdBy": "John Scott",
            "createdDate": "2025-05-21T11:09:11.23Z",
            "comment": "provide an update - refer email",
            "attachments": [],
            "orderingInstitutionName": "First Bank",
            "instructingInstitution": "Aspire Bank Ltd"
        },
        {
            "createdBy": "John Scott",
            "createdDate": "2025-05-21T11:23:11.574Z",
            "comment": "",
            "attachments": [],
            "orderingInstitutionName": "First Bank",
            "instructingInstitution": "Aspire Bank Ltd"
        }
    ]
}

Error Scenario

If you provide an invalid supportTicketIdin the API request, then an error is returned as shown below

{
    "title": "Bad Input",
    "status": 400,
    "detail": "Invalid Investigation ID. Please check and provide a valid investigation ID",
    "traceId": "00-5d0fddcc4e87a7ceaf5e59747af7ca33-83475b819921d5a6-00",
    "errorCode": "INV00004"
}