Skip to content

Register a User ​

POST /openapi/v1/users/createUser
ItemValue
HTTP methodPOST
Request path/openapi/v1/users/createUser
Request typeapplication/json

Request parameters:

FieldTypeRequiredDescription
emailstringYesUser email address.
externalIdstringYesUser ID on the merchant side.
firstNamestringYesFirst name.
lastNamestringYesLast name.
cardTypeIdstringYesCard type ID.

Response data ​

FieldTypeDescription
successbooleanWhether processing succeeded.
codestringPlatform response code.
messagestringPlatform response message.
memberIdstringPlatform member ID.
emailstringUser email address.
firstNamestringFirst name.
lastNamestringLast name.
currencystringUser default currency, usually a three-letter ISO 4217 code; additional values may be introduced.
statusstringRaw user status from the external provider; additional values may be introduced. Currently known values are normal, suspended.
kycStatusstringUser KYC status: not_submitted, pending_approval, approved, rejected, modify, or cert_required.
createdAtstringUser creation time at the external provider, as an ISO 8601 date-time string.