Skip to content
Levr API Documentation
Download OpenAPI specOpenAPI

Hand off to an AI agent

Copy instructions to your AI agent

Copy this guide into your AI agent. It links to the current REST API and MCP documentation.

You are helping someone integrate their system with Levr. Use Levr's published documentation and machine-readable contracts as the source of truth. Do not invent endpoints, fields, or MCP tools.

  1. Start with the Levr API documentation to choose between a server-to-server REST integration and a user-authorized MCP connection.
  2. For REST, read the Markdown REST API guide, choose the user’s task, then fetch only the relevant resource guide and operation Markdown. Resource indexes include task guidance. For funding recommendations, start with the Matchmaking guide. Use the OpenAPI specification for exact paths, authentication, parameters, and envelope schemas.
  3. For REST client intake, Deal applications, or project Criteria, fetch that resource's contract_url. Its Application Contract is the authority for the current questions, stable keys, repeatable groups, file-transfer steps, accepted answer shapes, conditional visibility, supported operation URLs, and integration instructions. Repeatable fields require the returned item_id. File bytes use the expiring upload_url and multipart field named file; they never belong in JSON. Do not substitute a static example or the latest application definition.
  4. For an AI client acting with a signed-in user's access, read the MCP connection instructions in Markdown first, then the Model Context Protocol guide if needed. Let the connected MCP server expose its current tools and input contracts; do not infer tools from the REST API. Read the relevant MCP resource guide and follow the discovered tool’s revision, file-transfer, and confirmation requirements.
  5. Use URLs from the record handoff when supplied; otherwise use this documentation environment. Keep API keys and file-transfer credentials out of browser code, logs, prompts, and source control.
  6. Before implementing a write, verify authentication, required inputs, idempotency, error responses, and retry guidance in the current contract. If an operation is not documented, do not assume it exists.

Early access

Request an integration

Tell us what your integration needs to do. Add an email if you want a reply.

Webhook event

Business status changed

A business moved to a different stage in the portal pipeline. It fires after Levr commits a change to the business's stage in this provider's business pipeline. Verify Levr-Signature against the unmodified request body before processing.

business.status_changed

A business moved to a different stage in the portal pipeline. It fires after Levr commits a change to the business's stage in this provider's business pipeline. Verify Levr-Signature against the unmodified request body before processing.

When it fires

After Levr commits a change to the business's stage in this provider's business pipeline.

Example payload

JSON
{
  "api_version": "v1",
  "created_at": "2026-08-19T16:42:13Z",
  "data": {
    "object": {
      "id": "biz_7fj3k9m2d8q4n6wx",
      "name": "Example Analytics Inc.",
      "object": "business",
      "status": {
        "changed_at": "2026-08-19T16:42:13Z",
        "pipeline": "Clients",
        "stage": "Underwriting"
      }
    }
  },
  "id": "evt_2m8q7c9k4x6p3n5d",
  "object": "event",
  "request": {
    "id": "req_2m8q7c9k4x6p3n5d"
  },
  "test_mode": false,
  "type": "business.status_changed"
}

Payload schema

View JSON schema
{
  "additionalProperties": false,
  "properties": {
    "api_version": {
      "const": "v1",
      "type": "string"
    },
    "created_at": {
      "format": "date-time",
      "type": "string"
    },
    "data": {
      "additionalProperties": false,
      "properties": {
        "object": {
          "additionalProperties": false,
          "properties": {
            "id": {
              "pattern": "^biz_[a-z0-9]+$",
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "object": {
              "const": "business",
              "type": "string"
            },
            "status": {
              "additionalProperties": false,
              "properties": {
                "changed_at": {
                  "format": "date-time",
                  "type": "string"
                },
                "pipeline": {
                  "type": "string"
                },
                "stage": {
                  "type": "string"
                }
              },
              "required": [
                "pipeline",
                "stage",
                "changed_at"
              ],
              "type": "object"
            }
          },
          "required": [
            "id",
            "object",
            "name",
            "status"
          ],
          "type": "object"
        }
      },
      "required": [
        "object"
      ],
      "type": "object"
    },
    "id": {
      "pattern": "^evt_[a-z0-9]+$",
      "type": "string"
    },
    "object": {
      "const": "event",
      "type": "string"
    },
    "request": {
      "oneOf": [
        {
          "additionalProperties": false,
          "properties": {
            "id": {
              "pattern": "^req_[a-z0-9]+$",
              "type": "string"
            }
          },
          "required": [
            "id"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "test_mode": {
      "type": "boolean"
    },
    "type": {
      "const": "business.status_changed",
      "type": "string"
    }
  },
  "required": [
    "id",
    "object",
    "type",
    "api_version",
    "created_at",
    "test_mode",
    "request",
    "data"
  ],
  "type": "object"
}

Before processing: verify Levr-Signature against the unmodified request body.