Transaction RFIs

As a transaction is submitted, Nium evaluates it to check if it can be automatically approved. A request that isn’t automatically approved undergoes a manual review.

The compliance status of the transaction changes during this process, and the client is notified with a webhook event through their <callback URL> in the following format:

POST https://<clientCallbackURL>?type=TRANSACTION&value={transactionId}

After receiving this notification for the transaction specified by transactionId, the client is expected to perform the following steps:

Step 1: Fetch the Transaction
Step 2: Respond to the Transaction RFI

Step 1: Fetch the Transaction

Fetch the Transaction API using the transactionID in the webhook event you received. The response of the Transaction API is an array of objects that contain the details of all the transactions created by the customer. The following fields include the details needed to complete the RFI flow:

Parameters	Type	Description
`complianceStatus`	string	This field denotes the compliance status of the transaction which can be any one of the following: `CLEAR` `PENDING` `RFI_REQUESTED` `REJECT`
`rfiDetails`	array of objects	This object contains the details of the RFIs if they have been requested by the agent for the transaction. The corresponding `complianceStatus` should be `RFI_REQUESTED` for this field to be considered by the client

`rfiDetails` array

This array includes the details of all the RFIs that Nium has raised.

NOTE:This array is only needed when complianceStatus is RFI_REQUESTED.

Parameters	Type	Description
`description`	string	The unique name of the RFI. For transactions with type = `data`, the `description`field can also be used to figure out the field name to use in the Respond to Transaction RFI request.
`documentType`	enum	The type of the document, if applicable. Available values include: POI POA null
`mandatory`	boolean	Details if the `requiredData` array needs to be included. Available values include `Yes` or `No`
`remarks`	string	Returns any remarks entered by the compliance agent while raising the RFI. Max. length: 255 characters
`rfiHashId`	string	The unique identifier (uuid) for the RFI. This field gets raised under the group of RFI objects.
`rfiId`	string	The unique identifier (uuid) for the group of RFIs raised for the transaction.
`rfiStatus`	enum	This field highlights whether the RFI has been responded to or not. Available values include: `RFI_REQUESTED`: this status highlights that the RFI is pending a response. `RFI_RESPONDED`: this status highlights that the client has responded to the RFI.
`transactionEntityType`	enum	Details the type of entity for whom the RFI has been raised. Available values include: `CREDITOR`: The beneficiary involved in the transaction `DEBTOR`: The remitter involved in the transaction
`type`	enum	Details if the RFI requires only data or if additional documents are required as well. Available values include: `data` `document`
`requiredData`	array of objects	Returns the data fields required as part of the RFI.

`requiredData` array

This array contains the fields of data required to be passed as part of each RFI:

Parameters	Type	Description
`label`	string	This text can be directly displayed on the form to the customer as a title for the RFI
`type`	string	Use this to configure the UI element. Available values include: `data` `document`
`value`	string	Details which Respond to Transaction RFI API field the value is sent in. See RFI types for valid values and additional details.

Step 2: Respond to the Transaction RFI

Use the Respond to RFI request to respond to the RFI. Depending on the rfiDetails array in the Get Transaction response, clients can build their response to the RFIs using the Respond to Transaction RFI request:

Parameters	Type	Description
`authCode`	string	The authorization code of the transaction for which the RFI was raised.
`clientHashId`	string	Your client hash ID to which the customer is linked.
`customerHashId`	string	The `customerHashId` created when the `customer` was initially created.
`walletHashId`	string	Your `walletHashId`.
`rfiResponseRequest`	array of objects	Contains information required by distinct RFIs - each denoted by `rfiHashId` in the Get Transaction API response.

📘
Note
Max character length for any parameter unless explicitly specified is 255.

`rfiResponseRequest` array

Parameters	Type	Description
`rfiHashId`	string	The `rfiHashId` of the RFI received as part of the Get Transaction API response.
`rfiResponseInfo`	object	The details required to be submitted as part of the RFI response in case of different types of RFIs.

`rfiResponseInfo` object

Use these fields to respond to the various types of RFIs. For more details on the different types of RFIs, see Transaction RFI Types.

The client needs to send only the information required in that specific RFI type. See RFI Examples for more details on how you can respond to each RFI.

Parameters	Type	Description
`bankAccountNumber`	string	The bank account number of the remitter/beneficiary.
`bankName`	string	The name of the bank of the remitter/beneficiary.
`dateOfBirth`	string	The date of birth of the remitter/beneficiary if they are individuals in YYY-MM-DD format.
`firstName`	string	The first name of the remitter/beneficiary if they are individuals.
`middleName`	string	The middle name of the remitter/beneficiary if they are individuals.
`lastName`	string	The last name of the remitter/beneficiary if they are individuals.
`nationality`	string	The nationality of the remitter/beneficiary if they are individuals.
`address`	object	The address of residence or address of registration depending on whether the remitter/beneficiary is an individual or a corporate entity.
`identificationDoc`	object	Submit the requested documents.
`additionalInfo`	object	This field is used to answer questions and collect any additional information about the remitter/beneficiary.

`address` object

Parameter	Type	Description
`addressLine1`	string	Line 1 of the remitter's/beneficiary's address. Max. limit: 100 characters
`addressLine2`	string	Line 2 of the remitter's/beneficiary's address. Max. limit: 100 characters
`city`	string	The city of the remitter's/beneficiary's address. Max. limit: 50 characters
`state`	string	The state of the remitter's/beneficiary's address.
`country`	string	The 2-letter ISO Alpha-2 country code representing the remitter’s/beneficiary's country.
`postcode`	string	The postal code of the customer’s address. Limit: 3-10 characters. Acceptable special characters include: `Hypen(-)` `Hash(#)` `Space( )`

`identificationDoc` object

Use this object to submit the documents and the details requested in RFI:

Parameter	Type	Description
`identificationType`	enum	The type of document that needs to be submitted. Available values include: APPLICANT_AUTHORITY_LETTER BANK_STATEMENT DRIVER_LICENCE GOVERNMENT_DOCUMENT INVOICE PASSPORT SALARY_STATEMENT PERSONAL_IMAGE UTILITY_BILL OTHERS
`identificationValue`	string	The ID number of the document requested in the RFI.
`identificationDocIssuanceCountry`	string	The issuance country of the document. SeeFetch corporate constants for the list of available values for the category `countryName`.
`identificationDocExpiry`	string	The expiry date of the document, if present, in `YYYY-MM-DD` format. This should be a future date.
`identificationDocIssuanceDate`	string	The issuance date of the document, if present, in `YYYY-MM-DD` format. Applicable if the document being submitted is an Australian Driver's Licence. This should be a past date.
`identificationDocIssuingAuthority`	string	The issuing authority of the document. Applicable if the document being submitted is an Australian Driver's Licence.
`identificationDocReferenceNumber`	string	The reference number of the document. Applicable if the document being submitted is an Australian Driver's Licence.
`identificationDocument`	array of objects	Used to submit the multiple documents requested in the RFI.

`identificationDocument` array

Parameter	Type	Description
`fileName`	string	Name of the file being submitted along with the extension
`fileType`	string	Type of the document file. Available values include: `application/pdf` `image/png` `image/jpg` `image/jpeg`
`document`	string	Base64 string of the document file.

`additionalInfo` object

Parameter	Type	Description
`otherData`	string	Used when responding to any additional questions or data requested by the compliance agent.

Step 1: Fetch the Transaction

rfiDetails array

requiredData array

Step 2: Respond to the Transaction RFI

📘Note

rfiResponseRequest array

rfiResponseInfo object

address object

identificationDoc object

identificationDocument array

additionalInfo object

`rfiDetails` array

`requiredData` array

📘
Note

`rfiResponseRequest` array

`rfiResponseInfo` object

`address` object

`identificationDoc` object

`identificationDocument` array

`additionalInfo` object