HomeGuidesAPI ReferenceChangelogDiscussions
GuidesAPI ReferenceDiscussions

## Introduction

With this quickstart guide, we’ve tried to make it as easy as possible to get up and running with Blend’s Public API. Please use this guide closely with the API Reference while developing.

## Getting Started

In order to get your API token reach out to [[email protected]](🔗) to engage to become a Blend Partner, or [[email protected]](🔗) if you are an existing Blend customer that wants to integrate via the APIs.

## Environments

We provide the following environments per Integrator organization:

  • Test API environment: <https://api.beta.blendlabs.com>

    • Used for testing. Shared space and all data is publicly available.

  • Production API environment: <https://api.blendlabs.com>

    • All API calls will be with live production data

When you initially request your credentials, we will give you the appropriate `blend-target-instance` for that environment.

If you are a partner, once you are ready to move to working with your first customer, you will need to request an implementation, infosec, and compliance review with [[email protected]](🔗) before you can access our customer's environments.

Once you have this review completed, you can request access to a specific customer's beta environment to set-up and test with that customer, and then request access to their production environment once the customer is ready to go live with the new integrations. See "Moving to Production" below for more info.

## Review Basic Request Formatting

Check out Blend's [API Technical Standards and Formats](🔗) to understand the how Blend's API is constructed, what kind of authentication and data formats it accepts, and what kind of errors you are likely to see.

## Write Your First API Call

A basic API call has 4 pieces:

  • Endpoint

  • Auth Token

  • Target Instance

  • Request body

Example curl:

## Error messages

All error scenarios where our server is able to respond to you will have the following error response object:

You can use the error and display fields to diagnose any non-500 error statuses and handle the errors appropriately.

If you get a 500 error or need any further assistance, please provide the error and trackingId along with the API call you attempted to make in a message to [[email protected]](🔗) to be able to triage your issue quickly and efficiently.

If you need to display an error message to end-users of your integration, we recommend that you pass through the display field (NOT the error field), which will include the appropriate information to prompt a user to be able to resolve their issue themselves or contact the Blend support team with additional context.

## Migrating to production for Partners

## Due Diligence Questionnaire

In order to migrate to production, you must fill out the Blend's Partner Due Diligence Questionnaire, and submit it for Blend review.

After Blend has reviewed the contents with the relevant Infosec, compliance, and implementation stakeholders, we will provide recommendations as needed and approve the request for production API credentials.

Customers that have signed the MSA Addendum with Blend do not have to fill out the Questionnaire.

## IP whitelisting

Additionally, IP whitelisting is a requirement before moving to production. Requests with valid Auth Tokens, Target Instances, and Access will still fail if they come from IPs that are not whitelisted with Blend.

## Getting Help

Take a look at any of the Developer Guides here or contact us at [[email protected]](🔗) if you have any questions.