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.

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

Response

GetRFIResp

Field	Type	Description
id	string	RFI field ID
rfi_details	RfiDetails	Main RFI details object
parent_rfi_details	ParentRfiDetails[]	Array of parent RFI details (Can be empty)
created_at	time.Time	RFI creation timestamp
updated_at	time.Time	RFI last update timestamp

RfiDetails

Field	Type	Description
prompt	string	RFI prompt/question text
is_document_required	boolean	Whether document submission is required
is_front_back_required	boolean	Whether front and back of document are required
rfi_document	RfiDocument	Document type and category information
transaction_details	TransactionDetails	Associated transaction information
transaction_id	string	Transaction ID if linked to a transaction
parent_rfi_id	string	ID of the parent RFI (if any)
kyc_link	KycLink	KYC platform link information

RfiDocument

Field	Type	Description
document_type_value	string	Document type value
document_type_label	string	Human-readable document type label
document_sub_type_value	string[]	Array of document subtype values
document_sub_type_label	string[]	Array of human-readable document subtype labels
document_categories	map[string][]string	Document categories mapping

ParentRfiDetails

Field	Type	Description
id	string	Parent RFI ID
rfi_details	RfiDetails	Parent RFI details (same structure as main RFI)
notes	string	Additional notes for the parent RFI
parent_documents	ParentDocument[]	Array of documents submitted for parent RFI

ParentDocument

Field	Type	Description
document_type	string	Type of document
document_sub_type	string	Subtype of document
number	string	Document number/identifier
issued_date	string	Document issue date (YYYY-MM-DD)
place_of_birth	string	Place of birth (if applicable)
expiry_date	string	Document expiry date (YYYY-MM-DD)
document_base64	string	Base64 encoded document content
comment	string	Additional comments about the document
signed_rfi_document_urls	string[]	Array of signed URLs for secure document access

TransactionDetails

Field	Type	Description
transaction_id	string	Unique transaction identifier
transfer_method	string	Transfer method used
transfer_type	string	Type of transfer (inbound/outbound)
source_amount	float64	Source amount in source currency
receiving_amount	float64	Receiving amount in destination currency
source_currency_code	string	Source currency code
source_currency_display_name	string	Human-readable source currency name
destination_currency_code	string	Destination currency code
destination_currency_display_name	string	Human-readable destination currency name
created_at	time.Time	Transaction creation timestamp

KycLink

Field	Type	Description
link	string	KYC platform link URL
expiry_date	time.Time	Link expiry timestamp

Response JSON Representation

{
  "data": [
    {
      "id": "rfi_field_123",
      "rfi_details": {
        "prompt": "Please provide proof of address",
        "is_document_required": true,
        "is_front_back_required": false,
        "rfi_document": {
          "document_type_value": "proof_of_address",
          "document_type_label": "Proof of Address",
          "document_sub_type_value": [
            "utility_bill"
          ],
          "document_sub_type_label": [
            "Utility Bill"
          ],
          "document_categories": {}
        },
        "transaction_details": {
          "transaction_id": "txn_456",
          "transfer_method": "bank_transfer",
          "transfer_type": "outbound",
          "source_amount": 1000,
          "receiving_amount": 950,
          "source_currency_code": "USD",
          "source_currency_display_name": "US Dollar",
          "destination_currency_code": "EUR",
          "destination_currency_display_name": "Euro",
          "created_at": "2024-01-15T10:30:00Z"
        },
        "transaction_id": "txn_456",
        "parent_rfi_id": "parent_rfi_789",
        "kyc_link": {
          "link": "https://kyc.link/123",
          "expiry_date": "2024-02-15T10:30:00Z"
        }
      },
      "parent_rfi_details": [
        {
          "id": "parent_rfi_789",
          "rfi_details": {
            "prompt": "Previous address verification",
            "is_document_required": true,
            "is_front_back_required": false,
            "rfi_document": {
              "document_type_value": "proof_of_address",
              "document_type_label": "Proof of Address",
              "document_sub_type_value": [
                "utility_bill"
              ],
              "document_sub_type_label": [
                "Utility Bill"
              ],
              "document_categories": {}
            },
            "parent_rfi_id": "grandparent_rfi_456",
            "kyc_link": {
              "link": "https://kyc.link/456",
              "expiry_date": "2024-02-10T10:30:00Z"
            }
          },
          "notes": "Previous address document submitted",
          "parent_documents": [
            {
              "document_type": "proof_of_address",
              "document_sub_type": "utility_bill",
              "number": "UTIL123456",
              "issued_date": "2024-01-01",
              "place_of_birth": "",
              "expiry_date": "2025-01-01",
              "document_base64": "base64_encoded_content",
              "comment": "Previous address document",
              "signed_rfi_document_urls": [
                "https://signed-url-1.com/document1",
                "https://signed-url-2.com/document2"
              ]
            }
          ]
        }
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

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" }