...

/

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

middle_name

String

Optional

User's middle name

Maximum length: 40 characters

gender

String

Optional

User's gender

birth_date

String

Optional

User's date of birth

Format: yyyy-MM-dd

city

String

Optional

City that corresponds to the user's address

Maximum length: 40 characters

state

String

Optional

2-letter state code that corresponds to the user's address

Sample values: NY, WA, TX

postal_code

String

Optional

Postal code that corresponds to the user's address

Maximum length: 10 characters

id_card_number

String

Optional

User’s identification card number

Maximum length: 255 characters

nationality

String

Optional

User's nationality

Maximum length: 255 characters

passport_number

String

Optional

User's passport number

Maximum length: 40 characters

ssn

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

address1

String

Cardholder's address

Maximum length: 255 characters

address2

String

Additional address information of the cardholder

Maximum length: 255 characters

authentication

Object

This object contains the cardholder's email, password, email_verified, email_verified_time, last_password_update_channel, and last_password_update_time. authentication.email_verified is true if the email is verified else false. authentication.last_password_update_channel specifies the path that was used to update the last password.

Format of authentication.email_verified_time and authentication.last_password_update_time: yyyy-MM-ddTHH:mm:ssZ

birth_date

String

The date of birth of the cardholder

business_token

Boolean

The unique ID of the business resource

city

Boolean

The city where the cardholder lives

company

String

The company's name

email

String

The valid email address of the cardholder

honorific

String

Cardholder's title or prefix: Mr., Ms., Miss, Mrs., etc.

id_card_expiration_date

String

The expiry date of the cardholder's ID card

id_card_number

String

The cardholder's id card number

ip_address

String

The cardholder's ip address

notes

String

Any additional information regarding the cardholder

parent_token

String

The unique id of the user or business already in the system

ssn

String

The cardholder's social security number

Note: Click here to get the complete list of request parameters and ...

Access this course and 1400+ top-rated courses and projects.