HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

Entrypoint URL Configuration

Overview

To support the different entry points a user may take when registering or logging in to Blend, your organization needs to establish an SSO Start Page and configure the necessary URL redirects.

Self-Serve Workflows

A consumer may enter the Blend application from a self-serve channel (e.g a public facing website) or another secure application within your organization.

Self-Serve Workflow Examples

Public facing website

A consumer may enter Blend from a public facing website, such as a marketing website, that highlights your values, explains your process, and highlights today's rates.

12001200

From within an established secure session

Consumers may enter Blend from within an already authenticated session. For example, they may begin their application after clicking on a widget within an online banking portal.

12001200

Notification Based Workflows

A consumer may enter the Blend application from a Notification such as an email that asks the consumer to take an action (e.g. Sign Up... or Complete a New Request).

Notification Based Workflow Examples

Email Notifications

Users may enter the Blend application after receiving an email invitation to apply by a loan officer or other party within your organization. The user will receive email notifications throughout their application process requesting they complete tasks or provide further information.

Email Invite

12001200

Email Notification

12001200

URL Redirect Configuration

To support redirecting your users to the appropriate URLs, your organization must provide Blend with an entrypoint URL. This URL will need to be able to handle query parameters to redirect the user to the appropriate experience.

Blend will use the entrypoint URL provided by your organization and append query parameters based on the context of the user. This is relevant for notification based workflows to ensure the appropriate user experience between systems.

URL Redirect Parameters

ParameterValue(s)Description
clientblendOptional parameter used to identity a redirect request coming from the Blend platform.
typesignUp or signInIndicates if the user is attempting to register or log in to the Blend platform.
partyprimary or coborrowerIndicates whether the user initiating the request is a primary party on the application or a coborrower (co-applicant).

SSO Start Page

Unlike a typical SSO implementation that might manage authorization to an internal resource within your organization, users will need to access the Blend platform who are not provisioned within your SAML server. To support this, your entrypoint URL should point to a "SSO Start Page".

The SSO Start Page provides an opportunity for your user to identify themselves and redirects them to the appropriate authentication experience.

The look and feel of the SSO Start Page are at your discretion.

10001000

URL Configuration Guide

Email Notification - Application Invite

Email notification requesting the user to start a new application on the Blend platform.

Entry Point URLRedirect Destination
https://yourEntrypointUrl.com?client=Blend&type=signUp&party=primarySSO Start Page
https://yourEntrypointUrl.com?client=Blend&type=signUp&party=coborrowerSSO Start Page

Email Notification - New Request or Reminder

Email notification requesting the user to start a new application on the Blend platform.

Entry Point URLRedirect Destination
https://yourEntrypointUrl.com?client=Blend&type=signIn&party=primaryIdP Sign In URL
https://yourEntrypointUrl.com?client=Blend&type=sign&party=coborrowerIdP Sign In URL
  • For registered, non SSO users, Blend will route the user directly to the Blend login page.