Skip to content

Register a User ​

POST /openapi/v2/users/createUser

V2 creates a platform user independently of a channel.

ItemValue
HTTP methodPOST
Request path/openapi/v2/users/createUser
Request typeapplication/json

Request parameters:

FieldTypeRequiredDescription
emailstringYesUser email address.
externalIdstringYesMerchant-side user ID, up to 64 characters.
firstNamestringYesFirst name.
lastNamestringYesLast name.

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.
statusstring/nullUser status; may be null before a service-provider identity is created.
kycStatusstringAggregate KYC status: not_submitted, pending, pending_approval, approved, rejected, modify, or cert_required.
createdAtstring/nullService-provider user creation time; null before that identity exists.

Input validation errors: V2 common responses.