<<Back

The Users API allows current user information to be updated and retrieved.

Endpoint: PUT /users/{userIdentifier}

Structure of API Call: PUT /programs/{programCode}/accounts/{accountIdentifier}/users/{userIdentifier}

• Updates Select Properties of a User

This endpoint gives the partner the ability to update an existing user’s information.

Business Rules

• Address, email and phone are all optional.

• If an address, email, or phone property is excluded, then that object is not updated or created.

• If there is only one existing phone number, then it is updated in place with the provided phoneType and number, even if the phoneType was changed.

• When there is more than one phoneNumber record then phones of the same type are updated. If the type is new, then a new record is created. For example, if there is an existing mobile phone entry and the mobile phone is provided, then it is updated. If a home phone did not previously exist and a home phone is provided, then it is created.

• Deletions of addresses and phoneNumbers are not currently supported.

User Data Response Codes & Sub-Codes

Note: All resulting errors will return an http status 400 along with the following Response Details for address, city length and invalid characters.

User Updates

• If an account is in a pending state, the user profile can be updated via the API.

• If an account is in a locked state, the user profile cannot be updated via the API.

• If a profile update is attempted for a locked account, the following response will be returned:

• HTTP Status: 200

• Code: 5

• subCode: 362

• Description: A user profile cannot be updated for a locked account

Active Consumer Account Limits

Social Security Number (SSN) Limits

• Up to 1 active account with the same SSN per program is allowed

• Up to 3 lifetime accounts with the same SSN per program are allowed

Phone Limits

• Up to 2 active accounts with the same phone number per program are allowed

• Up to 10 lifetime accounts with the same phone number per program are allowed

Note: Updates requested for phone numbers that exceed the current phone limits will be declined.

Response Codes

Endpoint: GET /users

Structure of API Call:

GET /programs/{programCode}/accounts/{accountIdentifier}/users

• Retrieve profile information for all associated users

This endpoint allows the retrieval of the users’ profile information, associated with a specific account.