Use the linked-institution/session/create endpoint to create a session for linking external financial institutions through various providers. This session can be used to initiate the linking process and manage institutions with the underlying providers.

You must supply both the provider being used and the list of services you require for the session. If the user has an existing linked institution, you can provide the linkedInstitutionId to reuse that institution for the session.

Creating a session is the first step in connecting an external institution (and external accounts) to a user. After creating a session and presenting either a hosted URL or SDK experience to the user, you will need to complete the linking process by calling the Complete Linked Institution Session endpoint once the user has finished the provider flow.

Two account verification services are available. account_verification returns the account owner details held by the institution. account_verification_with_match returns the same owner details and also compares them against the identity on the Spidr user record, so that completing the session returns an identityMatch object on each account. The two services cannot be requested together. account_verification_with_match must be enabled on the product, and each match run is billable.