Skip to main content
GET
/
customer
/
detail
Get customer details
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/customer/detail \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "id": "<string>",
    "realName": "<string>",
    "country": "<string>",
    "countryName": {},
    "nationality": "<string>",
    "nationalityName": {},
    "city": "<string>",
    "address": "<string>",
    "dob": {},
    "isIndividual": true,
    "email": "<string>",
    "externalId": "<string>",
    "sumsubLink": "https://in.sumsub.com/websdk/p/sbx_4pe01gDQ0uXG5lVw",
    "remark": "<string>"
  }
}

Authorizations

X-API-Key
string
header
required

Query Parameters

email
string

Customer email

Example:

"john.doe@example.com"

id
string

Customer ID

Example:

"6ac34182-aa2e-4290-ab1b-302a09f451d1"

externalId
string

External customer identifier from partner system

Example:

"partner-customer-001"

Response

Get customer successful

status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

data
object
required

Response data