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"
}Update member profile
Updates the member’s profile fields such as country code and address.
Authentication: Requires tenant API key or session authentication.
Access Control: Members can update their own profile. Admins and API keys can update any user in the tenant.
Country Code: Must be a 3-letter ISO 3166-1 alpha-3 code (e.g., “USA”, “PHL”, “GBR”).
Address: If provided, must include a valid countryCode field.
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
Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.
Path Parameters
Body
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)
Member display name (full name). Set to null to clear.
255"Chan Tai Man"
First/given name for KYC verification. Set to null to clear.
100"Tai Man"
Last/family name for KYC verification. Set to null to clear.
100"Chan"
Date of birth in YYYY-MM-DD format. Set to null to clear.
"1990-06-15"
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.
50"A1234567"
ISO 3166-1 alpha-3 country code (e.g., "HKG", "USA", "GBR"). Set to null to clear.
3"HKG"
Member address for KYC verification. Set to null to clear.
Show child attributes
Show child attributes
Response
Updated member profile
Member profile information including identity fields for KYC and payout accounts
Member user ID
Member display name (full name)
First/given name for KYC verification
"Tai Man"
Last/family name for KYC verification
"Chan"
Date of birth in YYYY-MM-DD format
"1990-06-15"
Government ID number (country-specific - HKID, SSN last 4, etc.)
"A1234567"
Member email address
ISO 3166-1 alpha-3 country code
3"HKG"
Member address following international address formats
Show child attributes
Show child attributes