Get RFI
Endpoint: GET https://api.zamp.finance/api/client/:clientid/customer/:customerid/kyc/:kycid/rfi
When the KYC status is rfi_requested
call this API to get all the information required to process the KYC.
Response
Key | Type | Description | Required |
---|---|---|---|
data | array | A list of RFI (Request for Information) entries. | Yes |
data.id | string | The unique identifier for the RFI. | Yes |
data.rfi_details | object | Details about the RFI prompt. | Yes |
data.rfi_details.prompt | string | The text of the RFI prompt presented to the user. | Yes |
data.rfi_details.is_document_required | boolean | Indicates if a document submission is required for the RFI. | No |
data.rfi_details.is_front_back_required | boolean | Indicates if both the front and back of a document are required for submission. | No |
data.rfi_details.transaction_id | string | The ID of the transaction associated with the RFI, if applicable. | No |
Response JSON Representation
{
"data": [
{
"id": "rfi_id_1",
"rfi_details": {
"prompt": "Are you politically exposed person",
"is_document_required": false,
"is_front_back_required": false
}
},
{
"id": "rfi_id_2",
"rfi_details": {
"prompt": "Please submit you passport",
"is_document_required": true,
"is_front_back_required": false
}
},
{
"id": "rfi_id_3",
"rfi_details": {
"prompt": "Please submit a proof, funds are not from illegal activity",
"is_document_required": true,
"is_front_back_required": false,
"transaction_id":"txn_id"
}
}
]
}