...
/Additional Parameters and Response Fields
Additional Parameters and Response Fields
This lesson provides a list of different endpoints and their additional parameters and response fields.
Users
Create a user
The table below provides a list of some additional request parameters that can be used to create a user. We can add these parameters to the request’s body when we create a user with the {BASE_URL}/users
endpoint.
Request Parameters
Parameter | Type | Category | Description |
| String | Optional | User's middle name Maximum length: 40 characters |
| String | Optional | User's gender |
| String | Optional | User's date of birth Format: |
| String | Optional | City that corresponds to the user's address Maximum length: 40 characters |
| String | Optional | 2-letter state code that corresponds to the user's address Sample values: |
| String | Optional | Postal code that corresponds to the user's address Maximum length: 10 characters |
| String | Optional | User’s identification card number Maximum length: 255 characters |
| String | Optional | User's nationality Maximum length: 255 characters |
| String | Optional | User's passport number Maximum length: 40 characters |
| String | Optional | User’s Social Security Number Note: This only contains digits. It doesn’t contain any delimiters. |
The table below provides a list of some additional response fields that are returned when the user is successfully created.
Response fields
Name | Type | Description |
| String | Cardholder's address Maximum length: 255 characters |
| String | Additional address information of the cardholder Maximum length: 255 characters |
| Object | This object contains the cardholder's Format of |
| String | The date of birth of the cardholder |
| Boolean | The unique ID of the business resource |
| Boolean | The city where the cardholder lives |
| String | The company's name |
| String | The valid email address of the cardholder |
| String | Cardholder's title or prefix: Mr., Ms., Miss, Mrs., etc. |
| String | The expiry date of the cardholder's ID card |
| String | The cardholder's id card number |
| String | The cardholder's ip address |
| String | Any additional information regarding the cardholder |
| String | The unique id of the user or business already in the system |
| String | The cardholder's social security number |
Note: Click here to get the complete list of request parameters and ...