# Instant Onboarding Quick Start Guide
source: https://developer.mastercard.com/open-finance-us/documentation/usecases/onboarding/instant-onboarding-quick-start/index.md

## Overview {#overview}

Follow this guide to:

* Introduce yourself to the Mastercard Instant Onboarding application and the foundational Open Finance APIs
* Get access to high-quality test data from our Sandbox environment

Note: Instant Onboarding uses the Data Connect SDKs to add new users to your platform.

## Create a Sandbox Project {#create-a-sandbox-project}

1. [Log in](https://developer.mastercard.com/account/log-in) or [sign up](https://developer.mastercard.com/account/sign-up) to Mastercard Developers and select **Create New Project**.

   ![](https://static.developer.mastercard.com/content/open-finance-us/uploads/create-mc-project.png)
2. Provide **Project Details**:

   1. Enter a name for your project.

   2. Choose if you want to create a project for yourself or for a client. Select **No** if this project is for yourself or select **Yes** to create the project on behalf of a client. If you are creating a project on behalf of a client, see [Partner Direct Model](https://developer.mastercard.com/open-finance-us/documentation/participant-model/partner-direct/index.md) and learn how you can [onboard your affiliate customers](https://developer.mastercard.com/open-finance-us/documentation/participant-model/partner-direct/onboarding-customers/index.md).

   3. Select **Open Finance** from the **Select your API service** drop-down list.

   4. From the **Commercial Countries** drop-down list, select **United States of America**. The United States is currently the only country where Instant Onboarding is supported. You cannot update Commercial Countries after this step. Ensure you have selected it before you continue.

   5. Click **Proceed**.

   ![](https://static.developer.mastercard.com/content/open-finance-us/uploads/onboarding-select-project-openfinance.png)
3. Provide **Service Details**:

   1. Enter a description for your Sandbox credentials.

   2. Click **Create Project**.

   ![](https://static.developer.mastercard.com/content/open-finance-us/uploads/onboarding-select-us-creds-openfinance.png)
4. In the **Credentials** section at left, click **Sandbox** to view the Sandbox credentials: `Partner ID`, `Secret`, and `App Key`. These credentials are required to call the APIs.

![](https://static.developer.mastercard.com/content/open-finance-us/uploads/sandboxcreds.png)
Note: If you need to use multiple environments for testing, for example, one test environment for developers and another for User Acceptance Testing (UAT), you can request additional Sandbox credentials with the **Add Partner ID** button.

## Welcome Your First Customer {#welcome-your-first-customer}

Follow the steps below to create a test customer and share some test accounts with Mastercard Open Finance. The corresponding **Customer ID** will be needed for retrieving account and financial data.

#### Step 1 - Create Access Token {#step-1---create-access-token}

Note: Requests to the Open Finance US APIs must originate from an IP address in the United States, United Kingdom, Canada or Australia.

All requests sent to Mastercard Open Finance must include a Finicity-App-Token HTTP header. Use your Partner ID and Secret with the following endpoint whenever you need to generate a new access token:

API Reference: `GET /aggregation/v2/partners/authentication`

#### Step 2 - Add Test Customer {#step-2---add-test-customer}

Create a "testing" customer record you can use with our test profiles. Test profiles only hit the Add Test Customer endpoint. Once you are satisfied with your testing, you can work with your Mastercard representative to use the Add Customer endpoint for real traffic.
Tip: Some of the fields in the test body are optional.
API Reference: `GET /aggregation/v2/customers/testing`

You can omit the `applicationId` from the request when generating testing customers.
-example command-
-example response-

Take a note of the `id` value returned. It's the Customer ID you will use next.

#### Step 3 - Generate a Mastercard Instant Onboarding URL {#step-3---generate-a-mastercard-instant-onboarding-url}

The next step is to generate an Instant Onboarding URL which you can present to the customer in your application. This enables the customer to start an Instant Onboarding session to begin onboarding them to your product by gathering their Prefill data and Open Finance accounts and financial data.

API Reference: `POST /connect/generate/instant-onboarding`

#### Step 4 - Use a Test Profile to Gather Prefill Data and Account Information {#step-4---use-a-test-profile-to-gather-prefill-data-and-account-information}

To simulate what a customer would experience when onboarding via Instant Onboarding, you can utilize one of our [testing profiles](https://developer.mastercard.com/open-finance-us/documentation/integration-and-testing/test-the-apis/index.md#instant-onboarding-testing-profiles).

1. Open the URL generated at the previous step.

2. Click **Next** to agree to the Terms and Conditions and Privacy Policy.

3. Input the phone number from the [testing profile](https://developer.mastercard.com/open-finance-us/documentation/integration-and-testing/test-the-apis/index.md#instant-onboarding-testing-profiles) and click **Next**.

<!-- -->

4. Enter the verification code and select **Verify and continue**.

5. Enter the secondary data associated with the testing profile and select **Next**.

   **Note:** The test experience utilizes DOB as the secondary data input. However, if you require SSN within your flow, you can test that by contacting your Mastercard representative and creating an Experience ID with SSN configured as the secondary data input.
6. Review the prefilled details, then proceed to permission the recognized account details by clicking **Share and continue to link**.

7. Select **Next** and then use **profile_03** for both the user name and the password on the login page. Once you have input the username and password, continue with the flow by pressing **Submit**.

8. Select the account you would like to add and continue to the flow.

9. Once you have finished adding the accounts, you are redirected back to your application.

#### Step 5 - Completing the Flow {#step-5---completing-the-flow}

When your customer completes the flow, you receive an onDone SDK event. You will not receive an onDone event via the SDKs if you have not integrated with one of our Data Connect SDKs. Integrating is not required for testing since you will be testing the flow yourself. However, the SDK integration is essential as it delivers the `onDone` event when the end user completes the flow and you retrieve the data.

API Reference: `POST /users/details`

After you have received the onDone SDK event and retrieved the details, you can direct the customer to the next portion of your flow and have successfully completed the Mastercard Instant Onboarding Flow. Use `redirectUri` (a field in the Connect Instant Onboarding URL endpoint) to specify where the customer is redirected to once they have completed the Instant Onboarding experience. For example, if your use case were "opening an account," you could direct the end user to a success screen with account details. Your sales engineer can help you configure the URL for your specific use case.
Note: Account and PII data become available upon receipt of the onDone SDK event. We recommend immediately fetching the data upon receipt; however, the data is available for 3 hours after the beginning of the session. Tip: If you have any questions or need assistance with the customer experience or development, please contact us.

## Resources {#resources}

* [Instant Onboarding](https://developer.mastercard.com/open-finance-us/documentation/usecases/onboarding/index.md)
* [Instant Onboarding User Events](https://developer.mastercard.com/open-finance-us/documentation/usecases/onboarding/instant-onboarding-events/index.md)