Blend

opencollection: 1.0.0
info:
  name: Blend Public API
  version: 12.0.0
  description: Documented REST surface of the Blend Labs digital lending and account-opening platform (developers.blend.com).
    Base URL https://api.blendlabs.com (production) or https://api.beta.blendlabs.com (beta). Requests use an authorization
    Bearer token plus blend-api-version and blend-target-instance (tenant~instance) headers. Access is credential-gated -
    tokens are issued to Blend customers and certified partners. Endpoints modeled from Blend's public documentation.
request:
  auth:
    type: bearer
    token: '{{bearerToken}}'
items:
- info:
    name: Home Lending Applications
    type: folder
  items:
  - info:
      name: List home lending applications
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/home-lending/applications?exportable=true
    docs: Lists home lending applications, with filters for export flows.
  - info:
      name: Create a home lending application
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/home-lending/applications
      body:
        type: json
        data: "{\n  \"party\": {\n    \"name\": { \"firstName\": \"Jane\", \"lastName\": \"Doe\" },\n    \"email\": \"jane.doe@example.com\"\
          \n  },\n  \"loanPurposeType\": \"PURCHASE\"\n}"
    docs: Creates a home lending application. Minimum input is the primary borrower name and email.
  - info:
      name: Get application data
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/home-lending/applications/:id
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
    docs: Retrieves a home lending application by ID.
  - info:
      name: Update application (losId, archive)
      type: http
    http:
      method: PATCH
      url: https://api.blendlabs.com/home-lending/applications/:id
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      body:
        type: json
        data: "{\n  \"losId\": \"LOS-12345\"\n}"
    docs: Updates application metadata, including the losId, or archives it.
- info:
    name: Documents & Export
    type: folder
  items:
  - info:
      name: Export loan application file
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/home-lending/applications/:id/file-export?format=MISMO_3_4
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      - name: format
        value: MISMO_3_4
        type: query
        description: FANNIE_MAE_3_2, MISMO_3_3_1, or MISMO_3_4.
    docs: Exports the loan application file in Fannie Mae 3.2 or MISMO 3.3.1/3.4 format.
  - info:
      name: Update export status
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/home-lending/applications/:id/export-status
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      body:
        type: json
        data: "{\n  \"status\": \"SUCCESS\"\n}"
    docs: Updates the export status (IN_PROGRESS, SUCCESS, FAILED) of an application.
  - info:
      name: Get application documents
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/applications/:id/documents
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
    docs: Retrieves the documents attached to an application.
- info:
    name: Borrowers & Parties
    type: folder
  items:
  - info:
      name: List parties
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/applications/:id/parties
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
    docs: Lists the parties (borrowers, coborrowers) on an application.
  - info:
      name: Add a party (coborrower)
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/applications/:id/parties
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      body:
        type: json
        data: "{\n  \"name\": { \"firstName\": \"John\", \"lastName\": \"Doe\" },\n  \"email\": \"john.doe@example.com\"\n\
          }"
    docs: Adds a coborrower or other party to an application.
- info:
    name: Follow-ups
    type: folder
  items:
  - info:
      name: List follow-ups
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/applications/:id/follow-ups
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
    docs: Lists follow-ups (borrower tasks/conditions) on an application.
  - info:
      name: Create a follow-up
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/applications/:id/follow-ups
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      body:
        type: json
        data: "{\n  \"title\": \"Upload most recent pay stub\"\n}"
    docs: Creates a follow-up requesting a document or action from the borrower.
- info:
    name: Closings & eSignature
    type: folder
  items:
  - info:
      name: Create a closing
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/closings
      body:
        type: json
        data: '{}'
    docs: Creates a closing.
  - info:
      name: Submit (send) a closing
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/closings/:closingId/send
      params:
      - name: closingId
        value: ''
        type: path
        description: The closing ID.
    docs: Submits a closing for processing.
- info:
    name: Events & Webhooks
    type: folder
  items:
  - info:
      name: List events
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/events
    docs: Lists event notifications such as Application Submitted and Documents Submitted.
  - info:
      name: Acknowledge event status
      type: http
    http:
      method: POST
      url: https://api.blendlabs.com/events/:eventId/status
      params:
      - name: eventId
        value: ''
        type: path
        description: The event ID.
      body:
        type: json
        data: "{\n  \"status\": \"ACKNOWLEDGED\"\n}"
    docs: Acknowledges an event so it is not redelivered.
- info:
    name: Lenders & Assignments
    type: folder
  items:
  - info:
      name: List lenders
      type: http
    http:
      method: GET
      url: https://api.blendlabs.com/lenders?emails=loanofficer@example.com
      params:
      - name: emails
        value: loanofficer@example.com
        type: query
        description: Comma-separated lender emails.
    docs: Retrieves lender users available for assignment.
  - info:
      name: Override assignees
      type: http
    http:
      method: PUT
      url: https://api.blendlabs.com/applications/:id/assignments
      params:
      - name: id
        value: ''
        type: path
        description: The application ID.
      body:
        type: json
        data: "{\n  \"assignees\": [\n    { \"userId\": \"user-123\", \"role\": \"PRIMARY_ASSIGNEE\" }\n  ]\n}"
    docs: Overrides the users assigned to an application.
bundled: true