m2pfintech
API LibraryCustomer Management

View Customer

Retrieves complete customer profile information by entity ID. Returns all associated data including account details, kit/card information, address records, communication contacts, KYC documents, and account-kit mappings. This is the primary API for getting a full view of a customer in the DCMS system.

POST
/viewCustomer

Authorization

tenantAuth
tenant<token>

The DCMS tenant name for multi-tenant isolation. Every API call must include this header to identify the client organization.

In: header

Header Parameters

tenant*string

The DCMS client or tenant name for multi-tenant isolation.

Request Body

application/json

entityId*string

Unique customer identifier (CIF number) in the DCMS system.

Response Body

application/json

application/json

curl -X POST "https://api.dcms.example.com/v1/viewCustomer" \  -H "tenant: ACME_BANK" \  -H "Content-Type: application/json" \  -d '{    "entityId": "675676"  }'
{
  "result": {
    "entityId": "675676",
    "entityType": "CUSTOMER",
    "firstName": "Aadhu",
    "middleName": "",
    "lastName": "Chandran",
    "title": "Miss",
    "gender": "FEMALE",
    "dob": "1978-06-01",
    "business": "ACME_BANK",
    "businessId": "687",
    "businessType": "ACME_BANK",
    "accountInfo": [
      {
        "accountNo": 8642135,
        "accountStatus": "ACTIVE",
        "accountType": "SAVING",
        "accountsCurrency": "INR",
        "defaultAccount": true,
        "initialFunding": "8000",
        "isPrimary": false,
        "schemeCode": "2003"
      }
    ],
    "kitInfo": [
      {
        "bin": "608040",
        "cardCategory": "DEBIT",
        "cardNumber": "608040XXXXXX6857",
        "cardStatus": "INACTIVE",
        "cardType": "VIRTUAL",
        "entityId": "675676",
        "expDate": "2029-07-31T00:00:00.000+00:00",
        "kitNo": "4240171642",
        "networkType": "RUPAY",
        "productId": "2003_VIRTUAL",
        "productName": "2003_VIRTUAL"
      }
    ],
    "addressInfo": [
      {
        "address1": "M2P Solutions Pvt Ltd",
        "address2": "Olympia Quest, Plot No:C1 & C56, SIDCO",
        "address3": "Thiru Vi Ka, Industrial Estate, Guindy",
        "addressCategory": "PERMANENT",
        "city": "CHENNAI",
        "country": "INDIA",
        "district": null,
        "isoCountryCode": null,
        "pincode": "600032",
        "state": "TAMILNADU"
      }
    ],
    "communicationInfo": [
      {
        "appId": null,
        "contactNo": "9876543210",
        "countryCode": null,
        "emailId": "test98765@gmail.com",
        "notification": true
      }
    ],
    "kycInfo": [
      {
        "countryOfIssue": null,
        "documentExpiry": "2099-03-01",
        "documentNo": "ABLIP7898E",
        "documentType": "PAN",
        "hashDocumentNo": "XXXXXXXX"
      }
    ],
    "accountKitMapping": [
      {
        "accountNo": 8642135,
        "entityId": "675676",
        "kitNo": "4240171642"
      }
    ]
  },
  "exception": null,
  "pagination": null
}
{
  "result": null,
  "exception": {
    "errorCode": "CUS001",
    "shortMessage": "Customer not found",
    "detailMessage": "No customer found for the given entity ID",
    "httpStatus": "BAD_REQUEST",
    "fieldError": [
      "Invalid entityId"
    ],
    "languageCode": "en"
  },
  "pagination": null
}