Search Customers

Search and filter customers based on various criteria like legal name, status, KYC status, dates, and balances

SecurityoAuth2
Request
query Parameters
page
integer
Default: 0

Page number

size
integer
Default: 10

Page size

Request Body schema: application/json
required

Search criteria for filtering customers

partnerId
string

Partner ID

customerUID
string

Unique Customer Id

legalName
string <= 255 characters

Legal Name of the customer

masterAccountNumber
string <= 255 characters

Master Account Number

createdDateFrom
string <date>

Start date for filtering by creation date

createdDateTo
string <date>

End date for filtering by creation date

lastUpdatedDateFrom
string <date>

Start date for filtering by last updated date

lastUpdatedDateTo
string <date>

End date for filtering by last updated date

balanceFrom
number <double>

Minimum balance for filtering

balanceTo
number <double>

Maximum balance for filtering

kycStatus
Array of strings

List of KYC statuses to filter customers

Items Enum: "Approved" "Pending" "Rejected"
status
Array of strings

List of customer statuses to filter customers

Items Enum: "Active" "Suspended"
Responses
200

OK

400

Bad request

401

You are not authorized to access the resource

403

Accessing the resource you were trying to reach is forbidden

404

The resource you were trying to reach is not found

500

Internal server error

503

Service unavailable

default

Successful

post/v2/customers/search
Request samples
application/json
{
  • "partnerId": "string",
  • "customerUID": "string",
  • "legalName": "xyz 123",
  • "masterAccountNumber": "xyz 123",
  • "createdDateFrom": "2019-08-24",
  • "createdDateTo": "2019-08-24",
  • "lastUpdatedDateFrom": "2019-08-24",
  • "lastUpdatedDateTo": "2019-08-24",
  • "balanceFrom": 0,
  • "balanceTo": 0,
  • "kycStatus": [
    ],
  • "status": [
    ]
}
Response samples
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}