| Field | Description |
|---|---|
| id | String, Yordex generated UUID that is unique for this user |
| gender | String, mandatory Gender of the user, can be "M" or "F" |
| firstName | String, mandatory First name of the user |
| lastName | String, mandatory Last name of the user |
| mobileNumber | String, mandatory The phone number country code without the leading zero, so for example "7707123456" |
| mobileNumberCountryCode | String, mandatory The phone number country code without the +, so for example "44" for the UK and "01" for the US |
| phoneCountryCode | String, Yordex generated 2-letter ISO country code corresponding to the mobileNumberCountryCode. This field is required to differentiate between countries with the same mobileNumberCountryCode, e.g. US and Canada |
| String, mandatory Email address of the user | |
| emailConfirmed | Boolean, Yordex generated The user has confirmed their email yes or no |
| traderAccounts | Object, Yordex generated A user can be associated with more than one trader. All traders a user is associated are listed here |
| . traderId | String, mandatory One of the traders that this user is associated with |
| . primaryAccount | Boolean, mandatory Whether this is the primary account or not. If a user logs in, the first account they are logged into is their primary account |
| roles | String, mandatory Role of this user. Possible values are listed on the right hand side |
| approvalLevel | String, optional Custom roles you can give this user to implement your required approval process, e.g. "Director" |
| managerUserId | String, optional The user id of the manager of this user which can be used in approval rules |
| approvalLimitAmountInCents | Number, optional The maximum amount up to which this user can approve orders in cents. If this field is not set, it is deemed to be zero and their manager will have to approve all their orders |
| approvalLimitCurrency | String, mandatory when approvalLimitAmountInCents is defined The currency for this order using the ISO-4217 standard. |
| expenseReimbursementCurrency | String, optional Currency in which we will reimburse your users for expenses. It will also be used as the default currency for their out-of-pocket expenses |
| receiptMandatoryThreshHoldInCents | Number, optional The amount in cents below which this user is not required to provide a receipt |
| delegates | Array, optional Other users who this user has delegated their account to. So users listed in this array will be able to log in as this user. |
| tags | Array, optional A set of customer defined key:value pairs |
| termsOfService | Array, optional If the user has accepted the cardholder terms of service. accepted:true/false |
| dateOfBirth | String, optional Date of birth of the user in yyyy-mm-dd format. Required before ordering cards with some US providers - your customer team contact will inform you if this is applicable to you. |
| address | Object, optional The address of the user. This may be required for some card programs - your customer team representative will inform you if this is the case. This is NOT the card delivery address of the user. |
| role | Role description |
|---|---|
| ROLE_TRADER_ADMIN | Admin user |
| ROLE_TRADER_STANDARD | Standard user |
| ROLE_TRADER_ADMIN_VIEW_ONLY | View only admin user |
| ROLE_TRADER_STANDARD_VIEW_ONLY | View only standard user |