Paperstac

This guide provides detailed instructions for developers at servicer companies who want to integrate their services with Paperstac. There are two types of integrations available:

​API Integration (Servicer provides API)

Paperstac API Integration (Servicer uses Paperstac API)

1. ​API Integration (Servicer provides API)
2. Paperstac API Integration (Servicer uses Paperstac API)

___________________________________________________________

API Integration (Servicer Provides API)

User Obtains API Key from Servicer

1. The servicer provides a way for their users to obtain an API key. This might be through a user profile section or a dedicated API access page.

User Creates Integration on Paperstac

1. The user logs into their Paperstac account.
2. They navigate to the integrations section and select the option to create a new integration.
3. The user enters the API key provided by the servicer.

1. Once the API key is entered and validated, Paperstac will start pulling data from the servicer’s API on the user’s behalf.
2. The data pulled will be integrated into the Paperstac platform, enabling the user to manage their loan assets efficiently.

1. User Obtains API Key from Servicer
 1. The servicer provides a way for their users to obtain an API key. This might be through a user profile section or a dedicated API access page.
2. User Creates Integration on Paperstac
 1. The user logs into their Paperstac account.
 2. They navigate to the integrations section and select the option to create a new integration.
 3. The user enters the API key provided by the servicer.
3. Data Pull from Servicer’s API
 1. Once the API key is entered and validated, Paperstac will start pulling data from the servicer’s API on the user’s behalf.
 2. The data pulled will be integrated into the Paperstac platform, enabling the user to manage their loan assets efficiently.

1. User logs into Servicer’s platform.
2. Navigates to the API Access page.
3. Generates or copies their API key.

1. Logs into Paperstac.
2. Goes to the Integrations section.
3. Selects “New Integration.”
4. Enters the API key from the Servicer.
5. Paperstac verifies and confirms the integration.

1. Paperstac regularly pulls data from the servicer’s API.
2. User sees updated loan data in Paperstac.

1. User Obtains API Key
 1. User logs into Servicer’s platform.
 2. Navigates to the API Access page.
 3. Generates or copies their API key.
2. User Creates Integration on Paperstac
 1. Logs into Paperstac.
 2. Goes to the Integrations section.
 3. Selects “New Integration.”
 4. Enters the API key from the Servicer.
 5. Paperstac verifies and confirms the integration.
3. Data Synchronization
 1. Paperstac regularly pulls data from the servicer’s API.
 2. User sees updated loan data in Paperstac.

Paperstac API Integration (Servicer Uses Paperstac API)

1. The user logs into their Paperstac account.
2. They navigate to the integrations section and select the option to create a new integration.
3. Paperstac provides an API key for the user.

1. The user provides the Paperstac API key to the servicer. This is usually done via a form on the servicer’s web app or platform.

1. The servicer uses the Paperstac API to push data to Paperstac on behalf of the user.
2. The servicer determines the mechanism for when and what data to push. For example:
3. A “Send to Paperstac” button next to a loan asset on the servicer’s website.
4. Continuous data synchronization whenever loan data changes.

1. User Creates Integration on Paperstac
 1. The user logs into their Paperstac account.
 2. They navigate to the integrations section and select the option to create a new integration.
 3. Paperstac provides an API key for the user.
2. User Provides API Key to Servicer
 1. The user provides the Paperstac API key to the servicer. This is usually done via a form on the servicer’s web app or platform.
3. Servicer Pushes Data to Paperstac
 1. The servicer uses the Paperstac API to push data to Paperstac on behalf of the user.
 2. The servicer determines the mechanism for when and what data to push. For example:
 3. A “Send to Paperstac” button next to a loan asset on the servicer’s website.
 4. Continuous data synchronization whenever loan data changes.

1. Logs into Paperstac.
2. Goes to the Integrations section.
3. Selects “New Integration.”
4. Receives an API key from Paperstac.

1. Logs into Servicer’s platform.
2. Navigates to a form or settings page to enter the Paperstac API key.
3. Submits the API key.

1. Implements functionality to push data to Paperstac:
   1. Example 1: User clicks “Send to Paperstac” button next to a loan asset, triggering a push of that loan’s data to Paperstac.
   2. Example 2: Continuous synchronization where the servicer’s platform pushes updates to Paperstac whenever loan data changes.

1. User Creates Integration on Paperstac
 1. Logs into Paperstac.
 2. Goes to the Integrations section.
 3. Selects “New Integration.”
 4. Receives an API key from Paperstac.
2. User Provides API Key to Servicer
 1. Logs into Servicer’s platform.
 2. Navigates to a form or settings page to enter the Paperstac API key.
 3. Submits the API key.
3. Servicer Pushes Data
 1. Implements functionality to push data to Paperstac:
 1. Example 1: User clicks “Send to Paperstac” button next to a loan asset, triggering a push of that loan’s data to Paperstac.
 2. Example 2: Continuous synchronization where the servicer’s platform pushes updates to Paperstac whenever loan data changes.