RFI Responded
This event is triggered when the client has successfully submitted a response to an RFI. It serves as a confirmation that Nium has received the response.
Endpoint:
POST https://<customerHost:Port>/webhook
Header
| Field | Value |
|---|---|
Content-Type | application/json |
Request example
{
"clientHashId": "b1cb53e3-6a1b-4b58-a10d-5a79c5967cef",
"customerHashId": "85c21489-94aa-4e65-ab7e-1c6bcea84e27",
"rfiDetails": {
"rfiId": "rfi_7f3a9c12",
"rfiEntityReferenceId": "txn_00099182",
"externalReferenceId": "ext_ref_99182",
"entityType": "CUSTOMER",
"rfiEntity": "TRANSACTION",
"status": "RFI_RESPONDED",
"query": "Please provide the source of funds for this transaction.",
"comment": "Include the originating account name and financial institution.",
"url": null,
"label": "Source of Funds",
"rfiExpiry": "2026-09-11T08:00:00.000Z",
"mandatoryFieldTypes": ["TEXT"],
"optionalFieldTypes": [],
"metadata": {
"text": null,
"enumCategory": null
},
"rfiRaisedAt": "2026-09-04T08:00:00.000Z",
"rfiRespondedAt": "2026-09-04T08:15:43.000Z"
}
}
Request body
| Field | Type | Description |
|---|---|---|
clientHashId | string | Your client hash ID. |
customerHashId | string | The customer identifier. |
rfiDetails | object | Full RFI object (see below). |
rfiDetails object
| Field | Type | Description |
|---|---|---|
rfiId | string | Stable, globally unique identifier for the RFI query. |
rfiEntityReferenceId | string | Reference ID of the entity the RFI was raised against. |
externalReferenceId | string | Reference ID shared by the client to Nium during onboarding or transactions. |
entityType | enum | Type of entity the RFI is about. Values: CUSTOMER, APPLICANT, STAKEHOLDER, REMITTER, BENEFICIARY, USER. |
rfiEntity | enum | Entity category for which the RFI was raised. Values: ONBOARDING, TRANSACTION, ICC_RECON, USER_ONBOARDING. |
status | enum | Always RFI_RESPONDED for this event. |
query | string | The original question that was asked. |
comment | string | Additional guidance provided by Nium when the RFI was raised. |
url | string | URL of a hosted form or downloadable template, when applicable. |
label | string | Standardised field label for the end-user UI. |
rfiExpiry | timestamp | Expiry date/time for the RFI. ISO-8601. |
mandatoryFieldTypes | array of enums | Response types requested by Nium. Values: TEXT, CHOICE, MULTI_CHOICE, ADDRESS, FILE_ATTACHMENT, IDENTITY_DOCUMENT, CONFIRMATION, DATE, URL. |
optionalFieldTypes | array of enums | Optional response types. Same enum values as mandatoryFieldTypes. |
metadata.text | string | Input format hint. |
metadata.enumCategory | string | Enum category code. |
rfiRaisedAt | timestamp | When Nium raised the RFI. ISO-8601. |
rfiRespondedAt | timestamp | When the client submitted the response. ISO-8601. |