POST
/clients/fiat/createCreate Fiat Client
Outcome - Registers a client in a fiat vault. Provide the IBAN if you may need to refund the client's deposits: refunds go back to this IBAN. Only available in fiat vaults.
Body Parameters
idstringrequiredmax(255)Your identifier for this client. Must be unique in the vault.
namestringrequiredmin(3)max(100)Full legal name, exactly as registered at the client's bank.
IBANstringSaudi IBANSaudi IBAN (starts with SA). Needed if you want to refund this client's deposits.
emailstringemail formatmax(255)Client email address.
mobilestringphone numberClient mobile number in international format.
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?