Review Customer Details

(For Creating a Card)

(For Creating a Card)This endpoint allows for the review of card creation for a specific customer. The review is necessary to ensure that all required documents / details have been updated and/or uploaded.

• Endpoint URL: /api/v1/customer/cards/reviewcreatecard?customersId={customerId}

• Method: GET

• Parameters

  • customersId: required - Unique identifier for the customer. Replace with the actual customer ID.

Note

• If the "Corporate Authorization Document" has been uploaded for the specified customer, the "requiredDocuments" object will be omitted in the response. This indicates that no additional documents are needed for this customer.

Example Request

GET /api/v1/customer/cards/reviewcreatecard?customersId=12345

Example Response

{
    "id": 0,
    "details": {
        "personalReviewDetails": {
            "sourceOfFunds": [
                "Salary"
            ],
            "estimatedGrossAnnualIncome": 10000.00,
            "estimatedNetWorth": 200000.00,
            "activelyEmployed": true,
            "employedCompanyName": "ABC Technologies",
            "employedJobTitle": "Software Engineer"
        },
        "types": {
            "sourceOfFunds": [
                "Salary",
                "Savings",
                "Self Employed",
                "Loans/Borrowed Funds"
            ]
        },
        "requiredDocuments": []
    },
    "status": "1",
    "errors": []
}

---

Upload Missing Document

This endpoint is used when clients need to upload missing documents. The previous endpoint to review customer details prior to creating a card will provide validation on whether documents are required to proceed with creating a card. For personal customers, this is typically a Tax Document, for corporate clients, this is a Corporate Authorization Document.

• Endpoint URL: /api/v1/customer/cards/documentupload

• Method: POST

• Content Type: Form Data

• Parameters

  • customersId: required - Unique identifier for the customer. Replace with the actual customer ID.

  • type : required - Identifies the type of document to be uploaded

    • Tax Document - Personal Customers

    • Corporate Authorization Document - Business Customers

  • documentSide: required - Default to 'Front', documents such as Driver Licensees also require a 'Back' side

  • file: requried - Selected file to be uploaded

Response Example

{
  "id": 0,
  "details": {
    "CustomersId": 1234,
    "type": "Tax Document",
    "documentSide": "Front",
    "fileID": "string"
  },
  "status": "1",
  "errors": [
    {
      "fieldName": "string",
      "messageCode": "string"
    }
  ]