Submit RFI
Endpoint: POST https://api.zamp.finance/api/client/:clientid/customer/:customerid/kyc/:kycid/rfi
When the KYC status is rfi_requested
call this API to submit all the information required to process the KYC.
Path Parameters
Parameter | Type | Required | Description |
---|---|---|---|
clientid | string | Yes | Super Merchant client ID |
customerid | string | Yes | Customer/Merchant ID |
kycid | string | Yes | KYC process ID |
Request
SubmitRfiDetailsReq
Field | Type | Required | Description |
---|---|---|---|
id | string | Yes | RFI field ID |
rfi_details | RfiDetailsReq | Yes | RFI details object |
RfiDetailsReq
Field | Type | Required | Description |
---|---|---|---|
notes | string | No | Additional notes or comments |
document | Document[] | No | Array of documents to submit |
Document
Field | Type | Required | Description |
---|---|---|---|
document_type | string | Yes | Type of document (e.g., "proof_of_address", "identity_document") |
document_sub_type | string | No | Subtype of document (e.g., "utility_bill", "passport") |
document_content_base64 | string | Yes | Base64 encoded document content |
document_number | string | No | Document number or identifier |
issued_Date | string | No | Document issue date (YYYY-MM-DD) |
expired_Date | string | No | Document expiry date (YYYY-MM-DD) |
Example JSON Request
[
{
"id": "rfi_field_123",
"rfi_details": {
"notes": "Additional information about the document",
"document": [
{
"document_type": "proof_of_address",
"document_sub_type": "utility_bill",
"document_content_base64": "base64_encoded_document_content",
"document_number": "DOC123456",
"issued_Date": "2024-01-01",
"expired_Date": "2025-01-01"
}
]
}
}
]
JSON Response
{
"data": {
"kyc_status":"in_review"
}
}
Error Responses
400 Bad Request json { "error": "Invalid request parameters", "code": "INVALID_PARAMS" }
401 Unauthorized json { "error": "Missing or invalid authentication token", "code": "UNAUTHORIZED" }
403 Forbidden json { "error": "Super Merchant and Merchant are not linked", "code": "ACCESS_FORBIDDEN" }
404 Not Found json { "error": "KYC process not found", "code": "NOT_FOUND" }
422 Unprocessable Entity json { "error": "Invalid RFI submission data", "code": "INVALID_RFI_DATA" }
500 Internal Server Error json { "error": "Unable to process RFI submission", "code": "INTERNAL_SERVER_ERROR" }