Skip to main content
GET
Get member profile

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Path Parameters

userId
string<uuid>
required

Response

Member profile

Member profile information including identity fields for KYC and payout accounts

id
string<uuid>

Member user ID

name
string | null

Member display name (full name)

givenName
string | null

First/given name for KYC verification

Example:

"Tai Man"

surname
string | null

Last/family name for KYC verification

Example:

"Chan"

dateOfBirth
string<date> | null

Date of birth in YYYY-MM-DD format

Example:

"1990-06-15"

idNumber
string | null

Government ID number (country-specific - HKID, SSN last 4, etc.)

Example:

"A1234567"

email
string<email>

Member email address

countryCode
string | null

ISO 3166-1 alpha-3 country code

Required string length: 3
Example:

"HKG"

address
object | null

Member address following international address formats

createdAt
string<date-time>
updatedAt
string<date-time>