POST
/clients/createCreate New Client
Outcome - Registers one of your customers as a client of this crypto vault. Wallet creation for every enabled network starts in the background. Only available in crypto API vaults.
Body Parameters
idstringrequiredmax(255)Your identifier for this client. Must be unique in the vault; RoxCustody returns it as externalId.
namestringmax(255)Client name.
emailstringemail formatmax(255)Client email address.
mobilestringphone numberClient mobile number in international format, for example +966500000000.
Responses
Response attributes
messagestringSuccess message
clientobjectThe created client
Show child attributes (7)
idnumberRoxCustody client ID
externalIdstringYour client id, as sent in the request
namestring | nullClient name
emailstring | nullClient email
mobilestring | nullClient mobile number
createdAtstringCreation date, format "DD Month, YYYY HH:mm:ss" (UTC)
updatedAtstringLast update date, same format
statusnumberHTTP status code
Was this page helpful?