Users

In Prime API, a User represents a Borrower or potential Borrower who logs into Prime to create an Application or view Loan Details. Each User is assigned a unique id, ensuring distinct identification within the system. A User is considered unique based on their email address and phone number.

Users represent a Partner end-user; the individual on whose behalf Partner creates and manages Applications, making them integral to the lending workflow.

When creating a User, the Partner must provide mandatory details such as an email address and phone number used for authentication. Partners can chose to also include a custom identifier external_id and any metadata relevant to the implementation with Prime. Partner is responsible for authenticating Users before establishing them in Prime’s system and allowing access to systems.

Users can be managed through Prime API, allowing Partners to:

• Create new Users
• Retrieve User information using their id, email, phone number, or external_id
• Update User details

Each User's data is scoped to a single organization. Partners can only access and manage Users associated with Partner’s organization. The User entity serves as the foundation for creating Applications and interacting with Borrower-specific endpoints.