Canopy Liens API

Manage liens for your customers in Canopy.

Operations 2

POST /core/v1/secured/collaterals/{collateral_id}/liens Create a lien #
PATCH /core/v1/secured/collaterals/{collateral_id}/liens/{lien_id}/terminate Terminate a lien on a collateral #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/canopyservicing-com:canopyservicing-com-liens-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canopyservicing-com-liens-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Canopy Servicing Core Liens API
  description: 'Canopy allows you to easily manage credit, installment, or other more complex lending programs from a servicing and compliance perspective -

    whether newly launched or migrated from existing systems. using canopy, you can track balances and transactions for each customer of your product, both in real-time and historically.

    You can see how various policy and product changes would impact your customers, and readily generate compliance reports and minimize your risk with all real-time information always on hand.

    Canopy additionally surfaces information around all of your lending activity through its intuitive ui which provides a customer support interface as well as at-a-glance data needed for compliance and insights.

    Simply configure your product`s policies through our create product api endpoint, and then you can immediately begin adding customer accounts and relying on canopy for accurate servicing information.'
  contact:
    name: Canopy Support
    url: https://www.canopyservicing.com/contact
    email: support@canopyservicing.com
  version: 1.0.0
servers:
- url: Contact sales to enable your sandbox
  description: Your private sandbox environment
- url: https://demo-api.us.canopyservicing.com
  description: Demo environment
tags:
- name: Liens
  description: Manage liens for your customers in Canopy.
paths:
  /core/v1/secured/collaterals/{collateral_id}/liens:
    post:
      tags:
      - Liens
      summary: Create a lien
      description: Creates a new lien on a collateral.
      operationId: CollateralsCBV_create_lien_core_v1_secured_collaterals__collateral_id__liens_post
      security:
      - HTTPBearer: []
      parameters:
      - name: collateral_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Collateral
          title: Collateral Id
        description: ID of the Collateral
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLienRequest'
              description: Lien creation parameters
      responses:
        '201':
          description: Returns the created lien.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLienResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '409':
          description: Entity already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrConflictSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
  /core/v1/secured/collaterals/{collateral_id}/liens/{lien_id}/terminate:
    patch:
      tags:
      - Liens
      summary: Terminate a lien on a collateral
      description: Terminates a lien on a collateral.
      operationId: CollateralsCBV_terminate_lien_core_v1_secured_collaterals__collateral_id__liens__lien_id__terminate_patch
      security:
      - HTTPBearer: []
      parameters:
      - name: collateral_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Collateral
          title: Collateral Id
        description: ID of the Collateral
      - name: lien_id
        in: path
        required: true
        schema:
          type: string
          description: ID of the Lien
          title: Lien Id
        description: ID of the Lien
      responses:
        '200':
          description: Returns the terminated lien.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLienResponse'
        '400':
          description: Your request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrBadRequestSchema'
        '404':
          description: Entity not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrNotFoundSchema'
        '409':
          description: Entity already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrConflictSchema'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: A server error has occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrServerErrorSchema'
components:
  schemas:
    GetLienAssociationResponse:
      properties:
        association_id:
          type: string
          title: Association Id
          description: The ID of the association (loan or line of credit) associated with the lien.
          hidden: false
        association_type:
          $ref: '#/components/schemas/AssociationType'
          description: The type of the association associated with the lien.
          hidden: false
      type: object
      required:
      - association_id
      - association_type
      title: GetLienAssociationResponse
    ErrBadRequestSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Your request is invalid.
      type: object
      required:
      - message
      title: ErrBadRequestSchema
    AssociationType:
      type: string
      enum:
      - LOAN
      - LINE_OF_CREDIT
      title: AssociationType
    LienStatus:
      type: string
      enum:
      - ACTIVE
      - LAPSED
      - RELEASED
      - TERMINATED
      title: LienStatus
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrNotFoundSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity not found.
      type: object
      required:
      - message
      title: ErrNotFoundSchema
    ErrConflictSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - Entity already exists.
      type: object
      required:
      - message
      title: ErrConflictSchema
    CreateLienRequest:
      properties:
        lien_id:
          type: string
          title: Lien Id
          description: The ID associated with the lien for future requests. If not provided on creation, Canopy will generate this field.
          examples:
          - lien_1
        position:
          type: integer
          exclusiveMinimum: 0
          title: Position
          description: The position of the lien in the list of liens associated with the collateral. The highest priority lien should have a position of 1.
          examples:
          - 1
          - 2
          - 3
          hidden: false
        include_in_ltv:
          type: boolean
          title: Include In Ltv
          description: Whether the lien should be included in the LTV calculation.
          examples:
          - true
          - false
          hidden: false
        outstanding_debt_amount_cents:
          type: integer
          title: Outstanding Debt Amount Cents
          description: The outstanding debt amount secured by this lien, in cents. This represents the current balance of debt that the lien secures. If not provided (null), this may indicate a blanket lien that secures all current and future debts.
          examples:
          - 1000000
        association:
          $ref: '#/components/schemas/CreateLienAssociationRequest'
          description: The association (loan or line of credit) associated with the lien. This should only reference loans/lines of credit that exist within Canopy.
          examples:
          - association_id: loan_123
            association_type: LOAN
          - association_id: line_of_credit_123
            association_type: LINE_OF_CREDIT
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          maxLength: 100
          title: Metadata
          description: Metadata associated with the lien.
          examples:
          - address: 123 Main St, Anytown, USA
            zip_code: '12345'
      type: object
      required:
      - position
      - include_in_ltv
      title: CreateLienRequest
    CreateLienAssociationRequest:
      properties:
        association_id:
          type: string
          title: Association Id
          description: The ID of the association (loan or line of credit) associated with the lien.
          examples:
          - loan_123
          - line_of_credit_123
          hidden: false
        association_type:
          $ref: '#/components/schemas/AssociationType'
          description: The type of the association associated with the lien.
          examples:
          - LOAN
          - LINE_OF_CREDIT
          hidden: false
      type: object
      required:
      - association_id
      - association_type
      title: CreateLienAssociationRequest
    ErrServerErrorSchema:
      properties:
        message:
          type: string
          title: Message
          description: The error message
          examples:
          - A server error has occurred.
      type: object
      required:
      - message
      title: ErrServerErrorSchema
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GetLienResponse:
      properties:
        lien_id:
          type: string
          title: Lien Id
          description: The ID of the lien.
          hidden: false
        status:
          $ref: '#/components/schemas/LienStatus'
          description: The status of the lien.
          hidden: false
        position:
          type: integer
          title: Position
          description: The position of the lien in the list of liens associated with the collateral.
          hidden: false
        include_in_ltv:
          type: boolean
          title: Include In Ltv
          description: Whether the lien should be included in the LTV calculation.
          hidden: false
        association:
          $ref: '#/components/schemas/GetLienAssociationResponse'
          description: The association (loan or line of credit) associated with the lien. This should only reference loans/lines of credit that exist within Canopy.
        outstanding_debt_amount_cents:
          type: integer
          title: Outstanding Debt Amount Cents
          description: The outstanding debt amount secured by this lien, in cents. This represents the current balance of debt that the lien secures. If missing, this may indicate a blanket lien that secures all current and future debts.
        metadata:
          anyOf:
          - additionalProperties: true
            type: object
          - items:
              additionalProperties: true
              type: object
            type: array
          - items: {}
            type: array
          title: Metadata
          description: Metadata associated with the lien.
          hidden: false
      type: object
      required:
      - lien_id
      - status
      - position
      - include_in_ltv
      title: GetLienResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer