The User is the foundational resource of every Abound API call. A User represents a single end-user of your application.

Each User has a unique userId, which should be stored in your database and used to make API requests on behalf of this individual.

Below are the User object's fields and descriptions:

Field

Description

userId

Unique value returned upon creation of a user, this should be stored in your database and used to make API requests on behalf of this individual.

foreignId

(Optional) The customer-specific unique identifier associated with this user.

email

Your user's email address. Abound assume's you have taken the proper steps to verify the ownership of this email address.

firstName

The user's legal first name.

lastName

The user's legal last name.

address

The user's legal street address. This CANNOT be a P.O. Box.

address2

The second part of the user's legal street address like an apartment or suite number.

city

The user's city, associated with a street address.

state

The two letter character code for this user's state ("ca" for California, "me" for Maine).

country

The user's country of residence. Adhering to the ISO 3166-2 format.

zipcode

The user's zipcode, associated with street address.

phoneNumber

The user's phone number. No country code. Numerical digits only.

dateOfBirth

The user's date of birth in the following format: YYYY-MM-DD

socialSecurityNumber

The user's social security number (SSN). No hyphens. Numerical digits only.

canWithhold

Ignore. To be deprecated