Add POST /referrer/{referrer_id}/invite-borrower endpoint
10 days ago by ReadMe API
Changes
This update introduces a new endpoint to handle borrower invitations by referrers, supporting onboarding processes with financial product enforcement and referral recommendations.
New Endpoints
POST /referrer/{referrer_id}/invite-borrower- Allows a referrer to invite a borrower, including optional parameters such as financial product ID, rate, and email.
- Returns either an onboarding link with expiration or IDs related to eligibility requests and onboarding.
Other Changes
- Added request and response definitions for the new endpoint:
ReferrerInviteBorrowerRequestobject with business identifier, optional email, financial product ID, and rate.ReferrerInviteBorrowerWithEmailResponseobject containing eligibility request ID, notification subscription ID, and onboarding ID.ReferrerInviteBorrowerWithLinkResponseobject containing the onboarding link and its expiration time.
