What are Lien Filings?
A lien is a legal claim or right against a property, typically used as security for a debt or obligation. The Lien Filing API facilitates the process of creating, managing, and submitting these legal documents.Key Features of the Lien Filing API
- Draft-Like Workflow: Create and gradually populate lien filings over time, mimicking the behavior of working with draft documents.
- Flexible Updates: Add or modify information in multiple steps, supporting both automated systems and user-driven interfaces.
- Secure Party Masking: Option to protect the identity of secured parties when required.
- Attachment Management: Programmatically upload, retrieve, and manage attachments associated with lien filings.
- Comprehensive Validation: Built-in checks to ensure all required information is present and correctly formatted before submission.
API Endpoints
The API introduces the following new endpoints:POST /businesses/{business_id}/lien_submissions: Create a new lien filing submissionGET /lien_submissions: Retrieve a list of lien filing submissionsGET /lien_submissions/{filing_id}: Get details of a specific lien filing submissionPUT /lien_submissions/{filing_id}: Update a lien filing submissionPOST /lien_submissions/{filing_id}/submit: Submit a completed lien filingPOST /lien_submissions/{filing_id}/cancel: Cancel a lien filing in “Needs Attention” statusDELETE /lien_submissions/{filing_id}: Delete a draft lien filing submission
Implementation Notes
- The API supports both full payload submissions and gradual population of lien filings, accommodating various integration scenarios.
- The draft-like behavior makes it suitable for driving user interfaces where users might save work in progress and return later.
- For M2M integrations, the API can be used to automate the creation and submission of lien filings based on predefined triggers or data flows.
- Proper error handling should be implemented to manage validation responses effectively.