HomeAPI ReferenceClientsCreate New Client
POST/clients/create

Create 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 number

Client mobile number in international format, for example +966500000000.

Responses

Response attributes

messagestring

Success message

clientobject

The created client

Show child attributes (7)
idnumber

RoxCustody client ID

externalIdstring

Your client id, as sent in the request

namestring | null

Client name

emailstring | null

Client email

mobilestring | null

Client mobile number

createdAtstring

Creation date, format "DD Month, YYYY HH:mm:ss" (UTC)

updatedAtstring

Last update date, same format

statusnumber

HTTP status code

Was this page helpful?