Skip to main content
PATCH
/
api
/
v1
/
members
/
{userId}
/
profile
curl --request PATCH \
  --url https://app.mlm-platform.com/api/v1/members/{userId}/profile \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-api-key: <api-key>' \
  --data '
{
  "givenName": "Tai Man",
  "surname": "Chan",
  "dateOfBirth": "1990-06-15",
  "idNumber": "A1234567"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "givenName": "Tai Man",
  "surname": "Chan",
  "dateOfBirth": "1990-06-15",
  "idNumber": "A1234567",
  "email": "jsmith@example.com",
  "countryCode": "HKG",
  "address": {
    "countryCode": "PHL",
    "addressLine1": "123 Rizal Avenue",
    "addressLine2": "Unit 4B, Sunrise Building",
    "city": "Makati City",
    "state": "Metro Manila",
    "postalCode": "1200",
    "district": "Barangay Poblacion",
    "neighborhood": "<string>",
    "addressType": "residential"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

Body

application/json

Request to update member profile fields. All fields are optional - only provided fields will be updated.

Identity fields (givenName, surname, dateOfBirth, idNumber, address) are used for:

  • KYC verification (matching against uploaded documents)
  • Payout account creation (Stripe Connect requires identity verification)
​
name
string | null

Member display name (full name). Set to null to clear.

Maximum string length: 255
Example:

"Chan Tai Man"

​
givenName
string | null

First/given name for KYC verification. Set to null to clear.

Maximum string length: 100
Example:

"Tai Man"

​
surname
string | null

Last/family name for KYC verification. Set to null to clear.

Maximum string length: 100
Example:

"Chan"

​
dateOfBirth
string<date> | null

Date of birth in YYYY-MM-DD format. Set to null to clear.

Example:

"1990-06-15"

​
idNumber
string | null

Government ID number for KYC verification. Country-specific format:

  • Hong Kong: HKID (e.g., "A1234567")
  • USA: Last 4 digits of SSN (e.g., "1234")
  • UK: National Insurance number (e.g., "AB123456C") Set to null to clear.
Maximum string length: 50
Example:

"A1234567"

​
countryCode
string | null

ISO 3166-1 alpha-3 country code (e.g., "HKG", "USA", "GBR"). Set to null to clear.

Required string length: 3
Example:

"HKG"

​
address
object

Member address for KYC verification. Set to null to clear.

Response

Updated 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

Member address following international address formats

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