---
title: "Get customer details (PWS)"
method: POST
path: "/pty/customer/v1/pws_get_customer_details"
tags: ["Ledger API - Customers"]
---

# Get customer details (PWS)

`POST /pty/customer/v1/pws_get_customer_details`

## Request

- Base URL: `https://api.uat.paymentology.com`
- URL: `https://api.uat.paymentology.com/pty/customer/v1/pws_get_customer_details`
- Auth: HTTP bearer

<ul>
<li class="docBullet">Ledger API version of the PWS <a href="https://developer.paymentology.com/bankinglive/reference/pws_get_customer_details">Get Customer Details</a> call. Request and response use the same format, served by the Ledger API.</li>
</ul>

## Request body

- LedgerGetCustomerRequest
  - `api_call_unique_identifier` string, required: Unique number that must be passed at each API request. Identifier to make each API request unique
  - `client_id` integer, required: Unique identifier for the client which Paymentology will provide at outset
  - `user_id` string: User Id of the Customer who triggered the API request.
  - `remarks` string: Remarks for API request
  - `cu_fname` string: Customer First Name
  - `cu_sname` string: Customer Last Name
  - `cu_email` string: Customer Email Id
  - `cu_ref` string: Customer Reference
  - `cu_id` integer, required: Customer Id

## Response `200`

Request processed. Check `header.error_id`: `0` means success. Any other value is a business error, reported with HTTP 200 and an empty `body`. Common codes: 992 (invalid account id), 993 (invalid card token), 995 (validation failed), 1043 (account does not belong to the client), 1055 (invalid program_code), 1531 (invalid customer id).

- LedgerGetCustomerResponse
  - `api_call_unique_identifier` string, required
  - `client_id` integer, required
  - `user_id` string
  - `remarks` string
  - `header` LedgerApiHeader, required
    - `error_id` integer, required
    - `error_desc` string, required
  - `body` object, required
    - `company` string
    - `cre_dt` string: Creation date-time (not ISO 8601; see the example for the format).
    - `cu_id` integer
    - `cu_fname` string
    - `cu_sname` string
    - `cu_type` integer
    - `cu_ref` string
    - `cu_bldg_no` string
    - `cu_add1` string
    - `cu_add2` string
    - `cu_pcode` string
    - `cu_city` string
    - `cu_country` string
    - `cu_email` string
    - `cu_mobile` string
    - `cu_pass_code` string
    - `cu_lang` string
    - `cu_nationality` string
    - `cu_gender` 1 | 2 | 3: Customer Gender. Possible values are: 1=Male 2=Female 3=Other
    - `cu_alternate_email` string
    - `cu_state` string
    - `cu_dob` string: Date of birth.
    - `default_rule_alert_sms_severity` integer
    - `default_rule_alert_email_severity` integer
    - `bank_customer_no` string
    - `is_main_cardholder` boolean
    - `cu_alternate_mobile` string
    - `cu_phone_home` string
    - `cu_id_type` string
    - `cu_id_number` string
    - `credit_rating` number, double
    - `credit_rating_source` integer
    - `display_name` string
    - `kyc_status` string
    - `kyc_status_details` string
    - `kyc_ext_reference` string
    - `key_provider_name` string: KYC key provider. May be returned as the literal string "null" when not set.
    - `kyc_attempt_count` integer
    - `kyc_attempt_date` string: Date-time of the last KYC attempt (not ISO 8601; see the example for the format).

## Other responses

- `400`: Request validation failed (missing or invalid fields, unknown fields, malformed JSON, or `client_id` not matching the access token). `header.error_id` is 400 and `header.error_desc` describes the failure.
- `401`: Missing or invalid access token. Empty body.
- `403`: Access token rejected by the API gateway (for example, expired).
- `404`: The customer or account was not found. `header.error_id` is 997.
- `413`: Request body too large. `header.error_id` is 413.
- `500`: Unexpected error. `header.error_id` is 900.

---

[API](https://skmtc.dev/paymentology/apis/ledger-api.md) - [All operations](https://skmtc.dev/paymentology/apis/ledger-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paymentology/apis/ledger-api/revisions/a5700c501bee?raw)