Information Requests (RFIs)

Overview

When transactions are flagged as high-risk, they are marked as pending on our system. Our compliance team will review transactions and may ask a customer for further information on a transaction to better understand the nature of the request. If an administrator needs more details to make this decision, they can send an information request (RFI) to the customer. This module will enable API users to retrieve information requests and respond with supporting documents and information.

When a information request is issued, API users will receive a callback notification. Similarly, when a request is updated (either being accepted, rejected, or requires more information), another callback request is sent.

Endpoints in this Section:

1. List Information Requests - Retrieves a list of information requests (RFIs). Optional filters can be applied to narrow down the list by customer.

2. Get Information Request Details - Retrieves detailed information about a specific information request using its unique ID.

3. Submit Information Request - Allows a customer to submit information and documents in response to an RFI.

---

List Information Requests

Retrieves a list of information requests (RFIs). Optional filters can be applied to narrow down the list by customer.

• Endpoint: /api/v1/customer/informationrequests/getinformationrequestlist

• Method: GET

• Response Format: application/json

GET Query Parameters

Request body parameter	Format	Description
CustomersId	int	Filter by this id (optional)
PageNumber	int	Page number (optional – default 1)
PageSize	int	Number of results per page (optional – default 10)

Example Success Response

{
    "id": 14152,
    "details": [
       {
            "id": 1004,
            "status": "More Information Required",
            "addDate": "2024-03-20T12:29:16.023",
            "expiryDate": "2024-03-27T12:29:16.023",
            "orderType": "OUT",
            "name": "Addison Payee",
            "reference": "United States Dollar: CTX31165",
            "amount": -20.000000000000000000,
            "currencySymbol": "$",
            "assetCode": "USD"
        },
        …
    ],
    "pageSize": 10,
    "pageNumber": 1,
    "numberOfPages": 2,
    "status": "1",
    "errors": []
}
	

Error message code example	Description
Invalid	Invalid request values
Unauthorized	User is not authorized for this action

---

Get Information Request Details

Retrieves detailed information about a specific information request using its unique ID.

• Endpoint: /api/v1/customer/informationrequests/ getinformationrequestdetails

• Method: GET

• Response Format: application/json

GET Query Parameters

Request body parameter	Format	Description
informationRequestsId	int	The information request to access

Example Success Response

{
    "id": 1004,
    "details": {
        "id": 1004,
        "status": "More Information Required",
        "orderType": "OUT",
        "name": "Addison Payee",
        "currencySymbol": "$",
        "assetCode": "USD",
        "amount": -20.000000000000000000,
        "description": "string",
        "responseFormGuid": "F0A88644-A105-4CF1-ACE0-B570F1411783",
        "supportingInformation": null,
        "supportingDocumentUploads": null
    },
    "status": "1",
    "errors": []
}

Error message code example	Description
Not_Found	InformationRequestsID not found
Invalid	User is not valid for this action

---

Submit Information Request

Allows a customer to submit information and documents in response to an RFI.

• Endpoint: /api/v1/customer/informationrequests/submitinformationrequest

• Method: POST

• Request format: form-data

• Response format: application/json

Request body parameter	Format	Description
CustomerAssetAccountsTransactionsInformationRequestsId	int	Id
ResponseFormGuid	string	GUID for identifying responses
SupportingInformation	string	Text response
SupportingDocumentUploads	file	One or more files to be uploaded as evidence

Request Body

CustomerAssetAccountsTransactionsInformationRequestsId
1004

ResponseFormGuid
BCBE8BF9-1171-4F60-B434-694C19BFDD9F

SupportingInformation
Example supporting information

SupportingDocumentUploads
/C:/Path/To/File/dummy.pdf

SupportingDocumentUploads
/C:/ Path/To/File/dummy_2.pdf	

Example Success Response

{
  "id": 1046,
  "status": "1",
  "errors": []
}	

Request body parameter	Format	Description
id	int	Id of the response

Error message code example	Description
Not_Found	InformationRequestsID not found
Invalid User	User is not valid for this action
Information_request_not_found	Information request does not exist with the expected status
Information_response_not_needed	Information response does not exist with the expected status
Response_form_already_submitted	Response form has been submitted with this GUID