Skip to main content

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
FieldValue
Content-Typeapplication/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

FieldTypeDescription
clientHashIdstringYour client hash ID.
customerHashIdstringThe customer identifier.
rfiDetailsobjectFull RFI object (see below).

rfiDetails object

FieldTypeDescription
rfiIdstringStable, globally unique identifier for the RFI query.
rfiEntityReferenceIdstringReference ID of the entity the RFI was raised against.
externalReferenceIdstringReference ID shared by the client to Nium during onboarding or transactions.
entityTypeenumType of entity the RFI is about. Values: CUSTOMER, APPLICANT, STAKEHOLDER, REMITTER, BENEFICIARY, USER.
rfiEntityenumEntity category for which the RFI was raised. Values: ONBOARDING, TRANSACTION, ICC_RECON, USER_ONBOARDING.
statusenumAlways RFI_RESPONDED for this event.
querystringThe original question that was asked.
commentstringAdditional guidance provided by Nium when the RFI was raised.
urlstringURL of a hosted form or downloadable template, when applicable.
labelstringStandardised field label for the end-user UI.
rfiExpirytimestampExpiry date/time for the RFI. ISO-8601.
mandatoryFieldTypesarray of enumsResponse types requested by Nium. Values: TEXT, CHOICE, MULTI_CHOICE, ADDRESS, FILE_ATTACHMENT, IDENTITY_DOCUMENT, CONFIRMATION, DATE, URL.
optionalFieldTypesarray of enumsOptional response types. Same enum values as mandatoryFieldTypes.
metadata.textstringInput format hint.
metadata.enumCategorystringEnum category code.
rfiRaisedAttimestampWhen Nium raised the RFI. ISO-8601.
rfiRespondedAttimestampWhen the client submitted the response. ISO-8601.
LLM-ready documentation:: llms.txt and llms-full.txt