HomeAPI ReferenceClientsBulk Create Fiat Clients
POST/clients/fiat/bulk-create

Bulk Create Fiat Clients

Outcome - Registers several fiat clients in one call. Each item has the same fields as Create Fiat Client. If any id already exists, nothing is created.

Body Parameters

clientsarrayrequiredmin(1) items

Fiat clients to create (at least one).

Show child parameters (5)
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 IBAN

Saudi IBAN (starts with SA). Needed if you want to refund this client's deposits.

emailstringemail formatmax(255)

Client email address.

mobilestringphone number

Client mobile number in international format.

Responses

Response attributes

messagestring

Success message

clientsarray

The created clients

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?