Skip to main content
GET
/
customer
/
list
Get customer list
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/customer/list \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "list": [
      {
        "id": "<string>",
        "realName": "<string>",
        "type": "<string>",
        "country": "<string>",
        "countryName": "<string>",
        "dob": "<string>",
        "remark": "<string>",
        "createTime": "<string>",
        "externalId": "<string>"
      }
    ],
    "total": 123,
    "pageNum": 123,
    "pageSize": 123
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

pageNum
number
default:1

Page number

Required range: x >= 1
pageSize
number
default:10

Page size

Required range: 1 <= x <= 100
sortField
string
default:createTime

Sort field

sortDirection
enum<string>
default:DESC

Sort direction

Available options:
ASC,
DESC
status
enum<string>

Filter by KYC / onboarding status

Available options:
PENDING,
CONFIRMED,
REJECTED,
DELETED
createTime
string

Filter by create time (ISO date string)

realName
string

Fuzzy match on real name

Response

Get customer list successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data