> ## Documentation Index > Fetch the complete documentation index at: https://docs.baselayer.com/llms.txt > Use this file to discover all available pages before exploring further. # Cancel Lien Filing Submission > Cancels a lien filing submission that has been rejected and sent back for revision (i.e. 'Needs Attention' status). This endpoint allows users to cancel a lien filing submission only if it is in 'Needs Attention' status. ## OpenAPI ````yaml /api-reference/openapi.json post /lien_submissions/{filing_id}/cancel openapi: 3.1.0 info: title: baselayer-api-service version: 0.1.0 servers: - url: https://api.baselayer.com/ security: [] paths: /lien_submissions/{filing_id}/cancel: post: tags: - Lien Filing summary: Cancel Lien Filing Submission description: |- Cancels a lien filing submission that has been rejected and sent back for revision (i.e. 'Needs Attention' status). This endpoint allows users to cancel a lien filing submission only if it is in 'Needs Attention' status. operationId: cancel_lien_filing_submission_lien_submissions__filing_id__cancel_post parameters: - name: filing_id in: path required: true schema: type: string format: uuid title: Lien Filing ID to cancel. description: The unique identifier of the lien filing submission to cancel. description: The unique identifier of the lien filing submission to cancel. responses: '200': description: Successfully canceled the lien filing submission. content: application/json: schema: anyOf: - $ref: '#/components/schemas/v1.LienFilingSubmissionUCC1Response' - $ref: '#/components/schemas/v1.LienFilingSubmissionUCC3Response' title: >- Response Cancel Lien Filing Submission Lien Submissions Filing Id Cancel Post '400': description: >- Cannot cancel a lien filing submission that is not in rejected status. content: application/json: schema: $ref: '#/components/schemas/APIError' title: CannotCancelLienFilingNotInNeedsAttentionStatus description: >- Cannot cancel a lien filing submission that is not in 'Needs Attention' status. examples: - code: 433 message: >- Cannot cancel a lien filing submission that is not in 'Needs Attention' status. metadata: {} '404': description: The lien filing submission does not exist. content: application/json: schema: $ref: '#/components/schemas/APIError' title: ResourceNotFound description: Could not locate the resource for the given URI. examples: - code: 1 message: Could not locate the resource for the given URI. metadata: {} '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: v1.LienFilingSubmissionUCC1Response: additionalProperties: false description: >- Represents the response structure for a lien filing submission. This model includes all the details provided during the creation of a lien filing submission along with additional system-generated information such as the unique identifier, the current status of the submission, and the filing number if the lien has been recorded. properties: reference_data: anyOf: - description: >- Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA). examples: - Filing for a 1967 Ford Mustang - 'Case #12345XYZ' - 'Debtor: John Doe' maxLength: 128 title: Reference Data type: string - description: No reference data is provided for the lien filing. title: No Reference Data type: 'null' default: null title: Reference Data submission_filing_name: anyOf: - description: A custom name for the filing (only filer's reference). examples: - My Lien Filing - Springfield Property Lien - 2023 Equipment Lien maxLength: 128 title: Filing Name type: string - description: >- The filing name will be automatically generated based on the debtor's name and the type of filing. title: No Filing Name provided. type: 'null' default: null title: Submission Filing Name search_to_reflect: anyOf: - description: >- When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office. title: Search to Reflect type: boolean - description: >- When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office. title: No Search to Reflect type: 'null' default: null title: Search To Reflect email_contact: anyOf: - description: >- This email will receive all correspondence concerning this lien filing. maxLength: 256 title: Lien Filing Email Contact type: string - description: >- No email contact has been provided for the lien filing submission. title: No Email Contact provided. type: 'null' default: null title: Email Contact real_estate_info: anyOf: - $ref: '#/components/schemas/v1.LienFilingRealEstateInfo' - $ref: '#/components/schemas/v1.LienFilingNoRealEstateInfo' - description: The real estate information will not be updated. title: Real Estate Information Omitted type: 'null' default: null description: >- The real estate information associated with the lien filing submission. title: Real Estate Information miscellaneous_info: anyOf: - description: >- Miscellaneous information associated with the lien filing submission. maxLength: 256 title: Miscellaneous Information type: string - description: >- No miscellaneous information has been provided for the lien filing submission. title: No Miscellaneous Information provided. type: 'null' default: null title: Miscellaneous Info filing_type: const: UCC1 default: UCC1 description: Initial financing statement, which is the first filing of a lien. title: Filing Type type: string state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation for the jurisdiction where the lien is to be filed. title: Jurisdiction State - description: >- No jurisdiction state has been provided for the lien filing. The jurisdiction will be automatically selected based on the business incorporation state. title: No Jurisdiction State provided. type: 'null' default: null title: State jurisdiction_county: anyOf: - description: >- The county where the lien is being filed. This is typically the county where the debtor's property or collateral is located. maxLength: 128 title: Jurisdiction County type: string - description: >- No jurisdiction county has been specified for this lien filing submission. The system will attempt to infer the county from the business against which the lien is being filed, but this inference may not always be successful. Depending on the state and type of lien being filed, specifying the county might still be required. title: No Jurisdiction County provided. type: 'null' default: null title: Jurisdiction County debtors: anyOf: - description: >- An enumeration of debtors implicated in the lien filing process, excluding the assigned debtor on anchored filings. Standalone filings return every debtor in this list. examples: - - capacity: ESTATE city: Springfield id: 6622b049-a93c-4748-8057-b5824fc52d0e mailing_address: 123 Main St organization_name: Acme Inc organization_type: COOPERATIVE postal_code: '62701' role: Debtor state: IL type: ORGANIZATION items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse title: Debtors type: array - description: No debtors are provided for the lien filing. title: No Debtors Provided type: 'null' default: null title: Debtors secured_parties: anyOf: - description: A list of secured parties involved in the lien filing. examples: - - city: Springfield id: 01bec728-36f8-4ba7-a6b6-4ec79c0cc35e is_assignor: null mailing_address: 123 Main St masked: null organization_name: Acme Inc organization_type: COOPERATIVE postal_code: '62701' role: Secured Party state: IL type: ORGANIZATION items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse title: Secured Parties type: array - description: No secured parties are provided for the lien filing. title: No Secured Parties Provided type: 'null' default: null title: Secured Parties collateral_statements: description: >- This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented. discriminator: mapping: ATTACHMENTS: $ref: >- #/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse TEXT: $ref: '#/components/schemas/v1.LienFilingCollateralStatementText' propertyName: type examples: - collateral_statement_designation: null text: >- Commercial real estate located at 123 Business Blvd, Tech City, TX type: TEXT - attachments: - document_filename: Ford Mustang 1967 Convertible.pdf id: 2e8a0860-abed-4f05-82e2-76d0ec4149f5 - document_filename: collateral_statement_details.pdf id: 1d95ccee-9586-42f6-856e-6c6d2ac3d420 collateral_statement_designation: null type: ATTACHMENTS oneOf: - $ref: '#/components/schemas/v1.LienFilingCollateralStatementText' - $ref: >- #/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse title: Collateral Statements alternative_name_designation: anyOf: - $ref: '#/components/schemas/v1.LienFilingAlternativeNameDesignation' description: >- Designation for the lien filing that specifies an alternativename under which the lien might be filed or recognized. This can includedesignations like agricultural liens, bailee/bailor relationships,or other specific types that affect how the lien is treated or categorized legally. title: Alternative Name Designation - description: No alternative name designation is provided for the lien filing. title: No Alternative Name Designation type: 'null' default: null title: Alternative Name Designation alternative_filing_type: anyOf: - $ref: '#/components/schemas/v1.LienFilingAlternativeType' description: >- Field that specifies the type of lien filing in alternativecontexts. This can include types like transmitting utility, manufactured home, public finance, or not applicable. title: Alternative Filing Type - description: No alternative filing type is provided for the lien filing. title: No Alternative Filing Type type: 'null' default: null title: Alternative Filing Type principal_indebted_amount: anyOf: - description: The principal indebted amount in the lien filing submission. pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Principal Indebted Amount type: string - description: >- No principal indebted amount has been provided for the lien filing submission. title: No Principal Indebted Amount provided. type: 'null' default: null title: Principal Indebted Amount documentary_tax_stamp_required: anyOf: - description: >- Whether a documentary tax stamp is required for the lien filing submission. When set to `true` all Documentary Stamps due and payable or to become due and payable pursuant, have been paid. If set to `false`, the lien filing submission will not require a documentary tax stamp. title: Documentary Tax Stamp Required type: boolean - description: >- No documentary tax stamp is provided for the lien filing submission. title: No Documentary Tax Stamp Provided type: 'null' default: null title: Documentary Tax Stamp Required tax_exempt_reason: anyOf: - $ref: '#/components/schemas/v1.LienFilingTaxExemptReason' description: The tax exempt reason for the lien filing submission. title: Tax Exempt Reason - description: >- No tax exempt reason has been provided for the lien filing submission. title: No Tax Exempt Reason provided. type: 'null' default: null title: Tax Exempt Reason assigned_business_debtor: anyOf: - $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse - type: 'null' default: null deprecated: true description: >- The debtor associated with the business against which the lien is filed. This debtor information is pre-filled based on the business details and cannot be modified (hence not appearing in POST and PUT requests). examples: - business_id: 8271b0c9-c2f6-4954-9779-a8fd9e0bb305 capacity: ESTATE city: Springfield id: 4fe66964-32c1-4d44-b146-14ab7b461dee mailing_address: 123 Main St organization_name: Acme Inc organization_type: LLC postal_code: '62701' role: Debtor state: IL type: ORGANIZATION title: Assigned Business Debtor assigned_debtor: anyOf: - discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse - type: 'null' description: >- The debtor associated with the business or person against which an anchored lien is filed. Standalone filings have no assigned debtor. title: Assigned Debtor id: description: The unique identifier for the lien filing submission. format: uuid title: Lien Filing Submission ID type: string filing_status: $ref: '#/components/schemas/v1.LienFilingSubmissionStatus' description: The current state of the lien filing submission. title: Lien Filing Submission Status filing_number: anyOf: - description: >- The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions. examples: - UCC1-1234567890 maxLength: 128 title: Lien Filing Number type: string - description: >- This field is set to `null` until the lien filing has been officially recorded. title: No Filing Number assigned yet. type: 'null' default: null title: Filing Number filing_date: anyOf: - description: The date when the lien filing was submitted to the jurisdiction. examples: - '2023-01-01' format: date title: Filing Date type: string - description: >- No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet. title: No Filing Date assigned yet. type: 'null' title: Filing Date lapse_date: anyOf: - description: >- The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. examples: - '2024-04-20' format: date title: Lapse Date type: string - description: >- No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet. title: No Lapse Date assigned yet. type: 'null' title: Lapse Date has_downloadable_document: default: false description: >- Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction. title: Has Downloadable Document type: boolean origin: $ref: '#/components/schemas/v1.LienFilingOrigin' default: filed_via_baselayer description: >- How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record. title: Lien Filing Origin status: anyOf: - $ref: '#/components/schemas/v1.LienFilingStatus' description: >- The lien's standing once it has been filed, derived from its lapse date under UCC §9-515 rather than read off a stored column — a filed lien whose lapse date has passed reports `Lapsed` here without anything having had to age it. Reads the same way as an imported filing's `status`. For a filing made THROUGH Baselayer both §9-515 clauses live in the filing's own UCC-3 amendments, so the field is populated only where those have been read: the initial-filing lookup (`POST /lien_submissions/initial_filing_lookup`). It is omitted elsewhere rather than answered from unread evidence. examples: - Active title: Lien Status - description: >- The submission has not been filed with the jurisdiction, so the lien it will create has no standing yet — or it was filed through Baselayer and this endpoint has not read the UCC-3 amendments its standing turns on. title: No Standing to Report type: 'null' default: null title: Status required: - filing_type title: LienFilingSubmissionUCC1Response (v1) type: object v1.LienFilingSubmissionUCC3Response: properties: reference_data: anyOf: - description: >- Reference text that will show up in the UCC form under box 8 (OPTIONAL FILER REFERENCE DATA). examples: - Filing for a 1967 Ford Mustang - 'Case #12345XYZ' - 'Debtor: John Doe' maxLength: 128 title: Reference Data type: string - description: No reference data is provided for the lien filing. title: No Reference Data type: 'null' title: Reference Data submission_filing_name: anyOf: - description: A custom name for the filing (only filer's reference). examples: - My Lien Filing - Springfield Property Lien - 2023 Equipment Lien maxLength: 128 title: Filing Name type: string - description: >- The filing name will be automatically generated based on the debtor's name and the type of filing. title: No Filing Name provided. type: 'null' title: Submission Filing Name search_to_reflect: anyOf: - description: >- When set to true, a search will be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office. title: Search to Reflect type: boolean - description: >- When set to false, a search will not be conducted on the debtor post-filing to verify that the filing has been properly registered by the filing office. title: No Search to Reflect type: 'null' title: Search To Reflect email_contact: anyOf: - description: >- This email will receive all correspondence concerning this lien filing. maxLength: 256 title: Lien Filing Email Contact type: string - description: >- No email contact has been provided for the lien filing submission. title: No Email Contact provided. type: 'null' title: Email Contact real_estate_info: anyOf: - $ref: '#/components/schemas/v1.LienFilingRealEstateInfo' - $ref: '#/components/schemas/v1.LienFilingNoRealEstateInfo' - description: The real estate information will not be updated. title: Real Estate Information Omitted type: 'null' title: Real Estate Information description: >- The real estate information associated with the lien filing submission. miscellaneous_info: anyOf: - description: >- Miscellaneous information associated with the lien filing submission. maxLength: 256 title: Miscellaneous Information type: string - description: >- No miscellaneous information has been provided for the lien filing submission. title: No Miscellaneous Information provided. type: 'null' title: Miscellaneous Info filing_type: const: UCC3 default: UCC3 description: Amendment or continuation of a previously filed financing statement. title: Filing Type type: string amendment_action: anyOf: - $ref: '#/components/schemas/v1.LienFilingUCC3TerminationAction' - $ref: '#/components/schemas/v1.LienFilingUCC3ContinuationAction' - $ref: '#/components/schemas/v1.LienFilingUCC3AssignmentActionResponse' - $ref: >- #/components/schemas/v1.LienFilingUCC3DebtorAmendmentActionResponse - $ref: >- #/components/schemas/v1.LienFilingUCC3SecuredPartyAmendmentActionResponse - $ref: >- #/components/schemas/v1.LienFilingUCC3CollateralAmendmentActionResponse - description: >- When updating the record with `null`, it will respect the existing server value for the `amendment_action` field of the filing document, causing no changes to this field. title: Amendment Action Omitted type: 'null' title: Amendment Action description: The action to be taken for the UCC-3 filing. authorizing_party: anyOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse' - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse' - $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse - description: When `null`, the authorizing party has not been set yet. title: Authorizing Party Not Set Yet type: 'null' title: Authorizing Party description: >- The party authorizing the UCC-3 filing amendment. This can be either the debtor or the secured party. id: description: The unique identifier for the lien filing submission. format: uuid title: Lien Filing Submission ID type: string filing_status: $ref: '#/components/schemas/LienFilingSubmissionStatus' title: Lien Filing Submission Status description: The current state of the lien filing submission. filing_number: anyOf: - description: >- The filing number assigned to the lien, when the lien filing has been recorded by the jurisdiction. This is a unique identifier for the lien, and is used to reference the lien in subsequent transactions. examples: - UCC1-1234567890 maxLength: 128 title: Lien Filing Number type: string - description: >- This field is set to `null` until the lien filing has been officially recorded. title: No Filing Number assigned yet. type: 'null' title: Filing Number filing_date: anyOf: - description: The date when the lien filing was submitted to the jurisdiction. examples: - '2023-01-01' format: date title: Filing Date type: string - description: >- No filing date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet. title: No Filing Date assigned yet. type: 'null' title: Filing Date lapse_date: anyOf: - description: >- The date when the lien will lapse. Assigned when the lien filing is submitted to the jurisdiction. examples: - '2024-04-20' format: date title: Lapse Date type: string - description: >- No lapse date has been assigned to the lien filing as the lien filing has not been submitted to the jurisdiction yet. title: No Lapse Date assigned yet. type: 'null' title: Lapse Date has_downloadable_document: default: false description: >- Indicates whether a downloadable document (e.g., the filed lien in PDF format) is available for this lien filing submission. This is typically true when the lien filing has been officially recorded by the jurisdiction. title: Has Downloadable Document type: boolean origin: $ref: '#/components/schemas/LienFilingOrigin' title: Lien Filing Origin description: >- How the organization came to own this lien filing: it was filed through Baselayer, or imported by the organization from a filing that already exists in the public record. default: filed_via_baselayer state: anyOf: - $ref: '#/components/schemas/StateAbbreviation' title: Jurisdiction State description: >- The state abbreviation for the jurisdiction where the amendment is to be filed. It is the jurisdiction of the filing being amended, copied when the amendment is created through `POST /lien_submissions/{filing_id}/amend`, and is not recomputed afterwards. - description: >- The filing being amended carried no jurisdiction state, so the amendment has none either. title: No Jurisdiction State provided. type: 'null' title: State amending_filing: $ref: '#/components/schemas/v1.LienFilingSubmissionUCC1Response' description: The filing that is being amended. title: Amending Filing additionalProperties: false type: object required: - filing_type title: LienFilingSubmissionUCC3Response (v1) APIError: properties: code: type: integer title: Code message: type: string title: Message uri: anyOf: - type: string - type: 'null' title: Uri metadata: additionalProperties: true type: object title: Metadata type: object required: - code - message title: APIError description: >- APIError is a Pydantic model for standardizing error responses from the API. This class is used internally by APIException for JSON serialization. Users should typically work with APIException directly in exception catalogs. HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError v1.LienFilingRealEstateInfo: description: >- This model represents the real estate record in a lien filing submission. properties: type: const: FILE_IN_REAL_ESTATE_RECORDS default: FILE_IN_REAL_ESTATE_RECORDS description: >- Indicates that this FINANCING STATEMENT is to be filed [for record] (or recorded) in the REAL ESTATE RECORDS. title: File In Real Estate Records type: string covers_timber: anyOf: - description: >- Whether the financing statement filed in the lien filing submission covers timber. title: Financing Statement Covers Timber type: boolean - description: Skipping the Timber flag of the financing statement. title: Financing Statement Covers Timber Skipped type: 'null' default: null title: Covers Timber covers_as_extracted_collateral: anyOf: - description: >- Whether the financing statement filed in the lien filing submission covers as-extracted collateral. title: Financing Statement Covers As Extracted Collateral type: boolean - description: >- Skipping the As Extracted Collateral flag of the financing statement. title: Financing Statement Covers As Extracted Collateral Skipped type: 'null' default: null title: Covers As Extracted Collateral filed_as_fixture: anyOf: - description: >- Whether the financing statement filed in the lien filing submission is filed as a fixture. title: Financing Statement Filed As Fixture type: boolean - description: Skipping the Fixture flag of the financing statement. title: Financing Statement Filed As Fixture Skipped type: 'null' default: null title: Filed As Fixture real_estate_record_owner: anyOf: - description: The owner of the real estate record of the lien filing. discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualRecordOwnerParty ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationRecordOwnerParty propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationRecordOwnerParty - $ref: '#/components/schemas/v1.LienFilingIndividualRecordOwnerParty' title: Real Estate Record Owner - description: Skipping the Real Estate Record Owner field. title: Real Estate Record Owner Skipped type: 'null' title: Real Estate Record Owner real_estate_description: anyOf: - description: A description of the real estate. maxLength: 1024 title: Real Estate Description type: string - description: Skipping the Real Estate Description field. title: Real Estate Description Skipped type: 'null' default: null title: Real Estate Description required: - type title: LienFilingRealEstateInfo (v1) type: object v1.LienFilingNoRealEstateInfo: description: >- This model represents the absence of real estate information associated with a lien filing. properties: type: const: NO_REAL_ESTATE_INFO default: NO_REAL_ESTATE_INFO description: >- Indicates that no real estate information is associated with the lien filing. title: Do not file in real estate records type: string required: - type title: LienFilingNoRealEstateInfo (v1) type: object v1.StateAbbreviation: enum: - AL - AK - AZ - AR - CA - CO - CT - DE - DC - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - PR - VI - AE - AA - AP - GU - AS title: StateAbbreviation type: string v1.LienFilingIndividualDebtorPartyResponse: description: >- Represents the response structure for an individual debtor party in a lien filing. This model encapsulates detailed information about an individual acting as a debtor, including their identification, contact details, and specific attributes relevant to their role in the lien. It is designed to provide a comprehensive view of the individual debtor's information as returned by the API in response to lien-related queries or operations. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code capacity: $ref: '#/components/schemas/v1.LienPartyDebtorCapacity' default: NONE_OF_THE_ABOVE description: >- The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien. title: Lien Debtor Capacity suffix: anyOf: - description: >- The suffix of the individual involved in the lien filing, if applicable. examples: - Jr. - Sr. - III maxLength: 16 title: Individual Suffix type: string - description: No suffix is provided for the individual. title: No Suffix type: 'null' default: null title: Suffix last_name: anyOf: - description: >- The last name of the individual involved in the lien filing, if applicable. examples: - Doe - Smith - Johnson maxLength: 16 title: Individual Last Name type: string - description: No last name is provided for the individual. title: No Last Name type: 'null' default: null title: Last Name first_name: anyOf: - description: >- The first name of the individual involved in the lien filing, if applicable. examples: - John - Jane - Alex maxLength: 16 title: Individual First Name type: string - description: No first name is provided for the individual. title: No First Name type: 'null' default: null title: First Name middle_name: anyOf: - description: >- The middle name of the individual involved in the lien filing, if applicable. examples: - Anne - Michael - Luis maxLength: 16 title: Individual Middle Name type: string - description: No middle name is provided for the individual. title: No Middle Name type: 'null' default: null title: Middle Name type: const: INDIVIDUAL description: >- Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity. title: Individual Party Type type: string role: const: Debtor default: Debtor description: >- Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien. title: Debtor Role type: string required: - type - role title: LienFilingIndividualDebtorPartyResponse (v1) type: object v1.LienFilingOrganizationDebtorPartyResponse: description: >- Represents the response structure for an organization acting as a debtor in a lien filing. This model encapsulates detailed information about an organizational debtor, including its identification, contact details, and specific attributes relevant to its role in the lien. It is designed to provide a comprehensive view of the debtor's information as returned by the API in response to lien-related queries or operations. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code capacity: $ref: '#/components/schemas/v1.LienPartyDebtorCapacity' default: NONE_OF_THE_ABOVE description: >- The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien. title: Lien Debtor Capacity organization_name: anyOf: - description: The name of the organization involved in the lien filing. examples: - Acme Inc - Globex Corporation - Initech LLC maxLength: 128 title: Organization Name type: string - description: No organization name is provided for the party. title: No Organization Name type: 'null' default: null title: Organization Name organization_type: anyOf: - $ref: '#/components/schemas/v1.BusinessStructure' description: >- The type of organization involved in the lien filing, if applicable. title: Organization Type - description: No organization type is provided for the party. title: No Organization Type type: 'null' default: null title: Organization Type type: const: ORGANIZATION description: >- Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person. title: Organization Party Type type: string role: const: Debtor default: Debtor description: >- Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien. title: Debtor Role type: string required: - type - role title: LienFilingOrganizationDebtorPartyResponse (v1) type: object v1.LienFilingIndividualSecuredPartyResponse: description: >- Represents the response structure for an individual secured party in a lien filing. This model encapsulates detailed information about an individual acting as a secured party, including their identification, contact details, and specific attributes relevant to their role in the lien. It is designed to provide a comprehensive view of the individual secured party's information as returned by the API in response to lien-related queries or operations. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code masked: anyOf: - description: >- A flag to indicate if the secured party should be masked when filing a lien. title: Masked type: boolean - description: The secured party is not masked when filing a lien. title: Not Masked type: 'null' default: null title: Masked is_assignor: anyOf: - description: Whether the secured party is the assignor of the lien. title: Is Assignor type: boolean - description: The assignor status of the secured party is not specified. title: Assignor Not Specified type: 'null' default: null title: Is Assignor suffix: anyOf: - description: >- The suffix of the individual involved in the lien filing, if applicable. examples: - Jr. - Sr. - III maxLength: 16 title: Individual Suffix type: string - description: No suffix is provided for the individual. title: No Suffix type: 'null' default: null title: Suffix last_name: anyOf: - description: >- The last name of the individual involved in the lien filing, if applicable. examples: - Doe - Smith - Johnson maxLength: 16 title: Individual Last Name type: string - description: No last name is provided for the individual. title: No Last Name type: 'null' default: null title: Last Name first_name: anyOf: - description: >- The first name of the individual involved in the lien filing, if applicable. examples: - John - Jane - Alex maxLength: 16 title: Individual First Name type: string - description: No first name is provided for the individual. title: No First Name type: 'null' default: null title: First Name middle_name: anyOf: - description: >- The middle name of the individual involved in the lien filing, if applicable. examples: - Anne - Michael - Luis maxLength: 16 title: Individual Middle Name type: string - description: No middle name is provided for the individual. title: No Middle Name type: 'null' default: null title: Middle Name type: const: INDIVIDUAL description: >- Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity. title: Individual Party Type type: string role: const: Secured Party default: Secured Party description: >- Indicates the role of the party as 'Secured', signifying their interest is protected by the lien. title: Secured Party Role type: string required: - type - role title: LienFilingIndividualSecuredPartyResponse (v1) type: object v1.LienFilingOrganizationSecuredPartyResponse: description: >- Represents the response structure for an organization acting as a secured party in a lien filing. This model encapsulates detailed information about an organizational secured party, including their identification, contact details, and specific attributes relevant to their role in the lien. It is designed to provide a comprehensive view of the secured party's information as returned by the API in response to lien-related queries or operations. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code masked: anyOf: - description: >- A flag to indicate if the secured party should be masked when filing a lien. title: Masked type: boolean - description: The secured party is not masked when filing a lien. title: Not Masked type: 'null' default: null title: Masked is_assignor: anyOf: - description: Whether the secured party is the assignor of the lien. title: Is Assignor type: boolean - description: The assignor status of the secured party is not specified. title: Assignor Not Specified type: 'null' default: null title: Is Assignor organization_name: anyOf: - description: The name of the organization involved in the lien filing. examples: - Acme Inc - Globex Corporation - Initech LLC maxLength: 128 title: Organization Name type: string - description: No organization name is provided for the party. title: No Organization Name type: 'null' default: null title: Organization Name organization_type: anyOf: - $ref: '#/components/schemas/v1.BusinessStructure' description: >- The type of organization involved in the lien filing, if applicable. title: Organization Type - description: No organization type is provided for the party. title: No Organization Type type: 'null' default: null title: Organization Type type: const: ORGANIZATION description: >- Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person. title: Organization Party Type type: string role: const: Secured Party default: Secured Party description: >- Indicates the role of the party as 'Secured', signifying their interest is protected by the lien. title: Secured Party Role type: string required: - type - role title: LienFilingOrganizationSecuredPartyResponse (v1) type: object v1.LienFilingCollateralStatementAttachmentsResponse: description: >- This model represents a collateral statement for a lien filing that includes one or more attachments (PDF documents), to provide additional details or evidence related to the collateral. Each attachment is identified by a unique ID and has an associated filename. properties: collateral_statement_designation: anyOf: - $ref: '#/components/schemas/v1.LienFilingCollateralStatementDesignation' description: >- The designation of the collateral statement, indicating the nature of the collateral as either having no special designation, being managed within a trust arrangement, or administered by the personal representative of a deceased individual. title: Collateral Statement Designation - description: >- When updating the field with `null`, it will respect the existing server value for the `collateral_statement_designation` field of the filing document, causing no changes to this field. title: Collateral Statement Designation Omitted type: 'null' default: null title: Collateral Statement Designation attachments: default: [] description: A list of PDF filenames as attachments. examples: - document_filename: Ford Mustang 1967 Convertible.pdf id: df9509da-0b1d-416b-bd75-9dbad14c99fa items: $ref: '#/components/schemas/v1.LienFilingAttachment' title: Attachments type: array type: const: ATTACHMENTS description: >- When using this type this structure represents a collateral statement for a lien filing that includes one or more attachments (PDF documents), to provide additional details or evidence related to the collateral. Each attachment is identified by a unique ID and has an associated filename. title: Type of Collateral Statement type: string required: - type title: LienFilingCollateralStatementAttachmentsResponse (v1) type: object v1.LienFilingCollateralStatementText: description: >- This structure represents the schema for a collateral statement in the form of text provided for a lien filing submission. properties: collateral_statement_designation: anyOf: - $ref: '#/components/schemas/v1.LienFilingCollateralStatementDesignation' description: >- The designation of the collateral statement, indicating the nature of the collateral as either having no special designation, being managed within a trust arrangement, or administered by the personal representative of a deceased individual. title: Collateral Statement Designation - description: >- When updating the field with `null`, it will respect the existing server value for the `collateral_statement_designation` field of the filing document, causing no changes to this field. title: Collateral Statement Designation Omitted type: 'null' default: null title: Collateral Statement Designation text: anyOf: - description: A plain text description of the collateral. examples: - >- Commercial real estate located at 123 Business Blvd, Tech City, TX - >- Inventory of electronics including laptops, smartphones, and tablets - Fleet of delivery vehicles comprising 5 trucks and 10 vans - >- Patents and intellectual property rights related to cybersecurity software title: Collateral Description Text type: string - description: >- When updating the field with `null`, it will respect the existing server value for the `text` field of the filing document, causing no changes to this field. title: Collateral Description Text Omitted type: 'null' default: null title: Text type: const: TEXT description: >- When using this type, the structure represents the schema for a collateral statement in the form of text provided for a lien filing submission. Setting the `"type":"TEXT"` will remove all previously uploaded attachments for this lien filing submission. title: Type of Collateral Statement type: string required: - type title: LienFilingCollateralStatementText (v1) type: object v1.LienFilingAlternativeNameDesignation: enum: - AGLIEN - BAILEE_BAILOR - CONSIGNEE_CONSIGNOR - LESSEE_LESSOR - NON_UCC_FILING - SELLER_BUYER - LICENSEE - DEBTOR_SECURED_PARTY title: LienFilingAlternativeNameDesignation type: string v1.LienFilingAlternativeType: enum: - TRANSMITTING_UTILITY - MANUFACTURED_HOME - PUBLIC_FINANCE - NOT_APPLICABLE title: LienFilingAlternativeType type: string v1.LienFilingTaxExemptReason: description: Enum for the tax exempt reason for a lien filing. enum: - DEBTOR_COOPERATIVE_MARKETING_ASSOCIATION - DEBTOR_CREDIT_UNION - DEBTOR_TELEPHONE_COOPERATIVE - GOVERNMENT_AGENCY - JUDGEMENT_LIEN - MUNICIPALITY - REORGANIZATION - SECURITIES - STATE_AGENCY - NOT_EXEMPT title: LienFilingTaxExemptReason type: string v1.LienFilingAssignedBusinessDebtorPartyResponse: description: >- Represents the response structure for an assigned business debtor party in a lien filing. This model includes details about the business entity acting as a debtor, such as its unique identifier, organizational information, and mailing address. It also incorporates additional response-specific fields like the party's ID. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code organization_name: anyOf: - description: The name of the organization involved in the lien filing. examples: - Acme Inc - Globex Corporation - Initech LLC maxLength: 128 title: Organization Name type: string - description: No organization name is provided for the party. title: No Organization Name type: 'null' default: null title: Organization Name organization_type: anyOf: - $ref: '#/components/schemas/v1.BusinessStructure' description: >- The type of organization involved in the lien filing, if applicable. title: Organization Type - description: No organization type is provided for the party. title: No Organization Type type: 'null' default: null title: Organization Type type: const: ORGANIZATION description: >- Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person. title: Organization Party Type type: string capacity: $ref: '#/components/schemas/v1.LienPartyDebtorCapacity' default: NONE_OF_THE_ABOVE description: >- The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien. title: Lien Debtor Capacity business_id: description: >- A unique identifier assigned to the business entity (debtor) involved in the lien filing process. format: uuid title: Business ID type: string role: const: Debtor default: Debtor description: >- Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien. title: Debtor Role type: string required: - type - role title: LienFilingAssignedBusinessDebtorPartyResponse (v1) type: object v1.LienFilingAssignedPersonDebtorPartyResponse: description: >- Represents the response structure for an assigned person debtor party in a lien filing. This model includes details about the person acting as a debtor, such as its unique identifier, organizational information, and mailing address. It also incorporates additional response-specific fields like the party's ID. properties: id: description: The unique identifier assigned to the lien filing party. format: uuid title: ID of the party type: string mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code suffix: anyOf: - description: >- The suffix of the individual involved in the lien filing, if applicable. examples: - Jr. - Sr. - III maxLength: 16 title: Individual Suffix type: string - description: No suffix is provided for the individual. title: No Suffix type: 'null' default: null title: Suffix last_name: anyOf: - description: >- The last name of the individual involved in the lien filing, if applicable. examples: - Doe - Smith - Johnson maxLength: 16 title: Individual Last Name type: string - description: No last name is provided for the individual. title: No Last Name type: 'null' default: null title: Last Name first_name: anyOf: - description: >- The first name of the individual involved in the lien filing, if applicable. examples: - John - Jane - Alex maxLength: 16 title: Individual First Name type: string - description: No first name is provided for the individual. title: No First Name type: 'null' default: null title: First Name middle_name: anyOf: - description: >- The middle name of the individual involved in the lien filing, if applicable. examples: - Anne - Michael - Luis maxLength: 16 title: Individual Middle Name type: string - description: No middle name is provided for the individual. title: No Middle Name type: 'null' default: null title: Middle Name type: const: INDIVIDUAL description: >- Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity. title: Individual Party Type type: string capacity: $ref: '#/components/schemas/v1.LienPartyDebtorCapacity' default: NONE_OF_THE_ABOVE description: >- The capacity in which the lien party is acting, particularly relevant when the party is a debtor. This field can indicate various legal standings such as being a trustee, managing an estate, or operating within a trust. Understanding the capacity is crucial for legal and financial assessments related to the lien. title: Lien Debtor Capacity person_id: description: >- A unique identifier assigned to the individual (debtor) involved in the lien filing process. format: uuid title: Person ID type: string role: const: Debtor default: Debtor description: >- Indicates the role of the party as 'Debtor', signifying their interest is protected by the lien. title: Debtor Role type: string required: - type - role title: LienFilingAssignedPersonDebtorPartyResponse (v1) type: object v1.LienFilingSubmissionStatus: description: >- Enum class delineating the various stages of a lien filing submission's lifecycle. enum: - Draft - Requested - InReview - NeedsAttention - Submitted - Filed - Cancelled title: LienFilingSubmissionStatus type: string v1.LienFilingOrigin: enum: - filed_via_baselayer - imported title: LienFilingOrigin type: string v1.LienFilingStatus: description: >- Enumeration of possible statuses for a lien filing. A lien filing's status indicates its current state within its lifecycle and legal enforceability. enum: - Active - Inactive - Lapsed - Released - Satisfied - Expired - Pending - Contested - Disputed - Perfected - Unperfected - Void - Invalid - Enforcement - Foreclosure - Subordinated - Avoided - Terminated - Draft - InPreperation - Unknown title: LienFilingStatus type: string v1.LienFilingUCC3TerminationAction: description: >- Represents a UCC-3 termination filing. This model defines the structure for a termination action in a UCC-3 filing. It is used to indicate the termination of a previously filed UCC-1 financing statement, signifying that the secured party no longer claims a security interest under that statement. properties: type: const: TERMINATION default: TERMINATION description: >- Indicates that this is a termination action for a UCC-3 filing. A termination statement is used to indicate that the secured party no longer claims a security interest under the financing statement. title: Termination type: string required: - type title: LienFilingUCC3TerminationAction (v1) type: object v1.LienFilingUCC3ContinuationAction: description: >- Represents a UCC-3 continuation filing. This model defines the structure for a continuation action in a UCC-3 filing. It is used to extend the effectiveness of a previously filed UCC-1 financing statement. > **NOTE:** A Continuation may be filed within 6 months of a filing's lapse date. properties: type: const: CONTINUATION default: CONTINUATION description: >- Indicates that this is a continuation action for a UCC-3 filing. A continuation statement is used to extend the effectiveness of the financing statement for an additional period of time. > **NOTE:** A Continuation may be filed within 6 months of a filing's lapse date. title: Continuation type: string required: - type title: LienFilingUCC3ContinuationAction (v1) type: object v1.LienFilingUCC3AssignmentActionResponse: properties: type: const: ASSIGNMENT default: ASSIGNMENT description: >- Indicates that this is an assignment action for a UCC-3 filing. An assignment is used to transfer some or all of the secured party's rights under the financing statement to another party. title: Assignment type: string assignment: description: >- Specifies the details of the assignment action. This can be either a partial assignment, where only some rights are transferred, or a full assignment, where all rights are transferred to the new secured party. discriminator: mapping: FULL: $ref: '#/components/schemas/v1.LienFilingUCC3FullAssignmentResponse' PARTIAL: $ref: >- #/components/schemas/v1.LienFilingUCC3PartialAssignmentResponse propertyName: type oneOf: - $ref: '#/components/schemas/v1.LienFilingUCC3PartialAssignmentResponse' - $ref: '#/components/schemas/v1.LienFilingUCC3FullAssignmentResponse' title: Assigment required: - type title: LienFilingUCC3AssignmentActionResponse (v1) type: object v1.LienFilingUCC3DebtorAmendmentActionResponse: properties: type: const: DEBTOR_AMENDMENT default: DEBTOR_AMENDMENT description: >- Indicates that this is a debtor amendment action for a UCC-3 filing. A debtor amendment is used to add, delete, or modify information about a debtor in the financing statement. title: Debtor Amendment type: string amendment: anyOf: - $ref: '#/components/schemas/v1.LienFilingUCC3AddDebtorAmendmentResponse' - $ref: >- #/components/schemas/v1.LienFilingUCC3EditDebtorAmendmentResponse - $ref: >- #/components/schemas/v1.LienFilingUCC3DeleteDebtorAmendmentResponse - description: The debtor amendment action is not set yet. title: Debtor Amendment Action Not Set type: 'null' default: null description: >- Specifies the type of debtor amendment action to be performed. This can be adding a new debtor, editing an existing debtor's information, or deleting a debtor from the financing statement. title: Debtor Amendment Action required: - type title: LienFilingUCC3DebtorAmendmentActionResponse (v1) type: object v1.LienFilingUCC3SecuredPartyAmendmentActionResponse: description: >- Represents a response model for a UCC-3 secured party amendment filing. This schema defines the structure for a secured party amendment action in a UCC-3 filing. It is used to add, delete, or modify information about a secured party in a previously filed financing statement. properties: type: const: SECURED_PARTY_AMENDMENT default: SECURED_PARTY_AMENDMENT description: >- Indicates that this is a secured party amendment action for a UCC-3 filing. A secured party amendment is used to add, delete, or modify information about a secured party in the financing statement. title: Secured Party Amendment type: string amendment: anyOf: - $ref: >- #/components/schemas/v1.LienFilingUCC3AddSecuredPartyAmendmentResponse - $ref: >- #/components/schemas/v1.LienFilingUCC3EditSecuredPartyAmendmentResponse - $ref: >- #/components/schemas/v1.LienFilingUCC3DeleteSecuredPartyAmendmentResponse - description: The secured party amendment action is not set yet. title: Secured Party Amendment Action Omitted type: 'null' default: null description: >- Specifies the type of secured party amendment action to be performed. This can be adding a new secured party, editing an existing secured party's information, or deleting a secured party from the financing statement. title: Secured Party Amendment Action required: - type title: LienFilingUCC3SecuredPartyAmendmentActionResponse (v1) type: object v1.LienFilingUCC3CollateralAmendmentActionResponse: description: >- Represents the response structure for a UCC-3 collateral amendment action. This model includes details about the collateral amendment, such as the type of amendment and the updated collateral statements. It provides a comprehensive view of the changes made to the collateral information in a UCC-3 filing. properties: type: const: COLLATERAL_AMENDMENT default: COLLATERAL_AMENDMENT description: >- Indicates that this is a collateral amendment action for a UCC-3 filing. A collateral amendment is used to add, delete, or modify information about the collateral described in the financing statement. title: Collateral Amendment type: string collateral_amendment_type: $ref: '#/components/schemas/v1.LienFilingCollateralAmendmentType' description: The type of amendment to be performed. title: Amendment Type collateral_statements: description: >- This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented. discriminator: mapping: ATTACHMENTS: $ref: >- #/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse TEXT: $ref: '#/components/schemas/v1.LienFilingCollateralStatementText' propertyName: type examples: - collateral_statement_designation: null text: >- Commercial real estate located at 123 Business Blvd, Tech City, TX type: TEXT - attachments: - document_filename: Ford Mustang 1967 Convertible.pdf id: 0109c929-5989-4386-803f-ace2b85f3221 - document_filename: collateral_statement_details.pdf id: 0012421a-b468-4233-bcfb-27abafa896b3 collateral_statement_designation: null type: ATTACHMENTS oneOf: - $ref: '#/components/schemas/v1.LienFilingCollateralStatementText' - $ref: >- #/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse title: Collateral Statements required: - type title: LienFilingUCC3CollateralAmendmentActionResponse (v1) type: object LienFilingSubmissionStatus: description: >- Enum class delineating the various stages of a lien filing submission's lifecycle. enum: - Draft - Requested - InReview - NeedsAttention - Submitted - Filed - Cancelled title: LienFilingSubmissionStatus type: string LienFilingOrigin: enum: - filed_via_baselayer - imported title: LienFilingOrigin type: string StateAbbreviation: enum: - AL - AK - AZ - AR - CA - CO - CT - DE - DC - FL - GA - HI - ID - IL - IN - IA - KS - KY - LA - ME - MD - MA - MI - MN - MS - MO - MT - NE - NV - NH - NJ - NM - NY - NC - ND - OH - OK - OR - PA - RI - SC - SD - TN - TX - UT - VT - VA - WA - WV - WI - WY - PR - VI - AE - AA - AP - GU - AS title: StateAbbreviation type: string 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 v1.LienFilingIndividualRecordOwnerParty: description: Represents an individual record owner party involved in a lien filing. properties: mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code suffix: anyOf: - description: >- The suffix of the individual involved in the lien filing, if applicable. examples: - Jr. - Sr. - III maxLength: 16 title: Individual Suffix type: string - description: No suffix is provided for the individual. title: No Suffix type: 'null' default: null title: Suffix last_name: anyOf: - description: >- The last name of the individual involved in the lien filing, if applicable. examples: - Doe - Smith - Johnson maxLength: 16 title: Individual Last Name type: string - description: No last name is provided for the individual. title: No Last Name type: 'null' default: null title: Last Name first_name: anyOf: - description: >- The first name of the individual involved in the lien filing, if applicable. examples: - John - Jane - Alex maxLength: 16 title: Individual First Name type: string - description: No first name is provided for the individual. title: No First Name type: 'null' default: null title: First Name middle_name: anyOf: - description: >- The middle name of the individual involved in the lien filing, if applicable. examples: - Anne - Michael - Luis maxLength: 16 title: Individual Middle Name type: string - description: No middle name is provided for the individual. title: No Middle Name type: 'null' default: null title: Middle Name type: const: INDIVIDUAL description: >- Specifies the party type as 'Individual' for the context of this lien filing, indicating that the party is a person rather than an organization or entity. title: Individual Party Type type: string required: - type title: LienFilingIndividualRecordOwnerParty (v1) type: object v1.LienFilingOrganizationRecordOwnerParty: description: Represents an organization record owner party involved in a lien filing. properties: mailing_address: anyOf: - description: >- The mailing address for the lien filing party, excluding city, state, and postal code. examples: - 123 Main St - 456 Elm St Apt 101 - 789 Pine St NW Suite 500 maxLength: 128 title: Mailing Address type: string - description: No mailing address is provided for the party. title: No Mailing Address type: 'null' default: null title: Mailing Address city: anyOf: - description: The city of the lien filing party's mailing address. examples: - Springfield - Metropolis - Gotham maxLength: 128 title: City type: string - description: No city is provided for the party. title: No City type: 'null' default: null title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' description: >- The state abbreviation of the lien filing party's mailing address. examples: - AL - CA - NY title: State - description: No state is provided for the party. title: No State type: 'null' default: null title: State postal_code: anyOf: - description: The postal code of the lien filing party's mailing address. examples: - '62701' - '90210' - '10001' maxLength: 16 title: Postal Code type: string - description: No postal code is provided for the party. title: No Postal Code type: 'null' default: null title: Postal Code organization_name: anyOf: - description: The name of the organization involved in the lien filing. examples: - Acme Inc - Globex Corporation - Initech LLC maxLength: 128 title: Organization Name type: string - description: No organization name is provided for the party. title: No Organization Name type: 'null' default: null title: Organization Name organization_type: anyOf: - $ref: '#/components/schemas/v1.BusinessStructure' description: >- The type of organization involved in the lien filing, if applicable. title: Organization Type - description: No organization type is provided for the party. title: No Organization Type type: 'null' default: null title: Organization Type type: const: ORGANIZATION description: >- Specifies the party type as 'Organization' for the context of this lien filing, indicating that the party is an organization or entity rather than a person. title: Organization Party Type type: string required: - type title: LienFilingOrganizationRecordOwnerParty (v1) type: object v1.LienPartyDebtorCapacity: description: |- Defines the various capacities a debtor may assume in the context of a lien, aiding in the comprehension of their legal standing and obligations concerning the lien. enum: - ESTATE - TRUST - TRUSTEE - NONE_OF_THE_ABOVE title: LienPartyDebtorCapacity type: string v1.BusinessStructure: enum: - SOLE_PROPRIETORSHIP - GENERAL_PARTNERSHIP - LLC - LLP - LLLP - LP - C_CORPORATION - S_CORPORATION - B_CORPORATION - NONPROFIT - COOPERATIVE - TRUST - PROFESSIONAL_ASSOCIATION - PROFESSIONAL_CORPORATION - TRADE_NAME - BANK - CREDIT_UNION - INSURANCE - OTHER title: BusinessStructure type: string v1.LienFilingCollateralStatementDesignation: description: Enumeration of possible designations for a lien collateral statement. enum: - NONE - TRUST - PERSONAL_REPRESENTATIVE title: LienFilingCollateralStatementDesignation type: string v1.LienFilingAttachment: description: >- Part of the lien filing submission response and /attachments management endpoints. This is included in the response when filing a lien with attachments or managing attachment files. properties: id: description: The unique identifier of the lien filing attachment. format: uuid title: Attachment ID type: string document_filename: description: >- The filename of the document associated with this lien filing attachment. examples: - lien_document.pdf - attachment_001.pdf - contract_agreement.pdf maxLength: 256 title: Attachment Filename type: string required: - id - document_filename title: LienFilingAttachment (v1) type: object v1.LienFilingUCC3FullAssignmentResponse: properties: type: const: FULL description: >- Indicates a full assignment of the lien filing. In a full assignment: - The entire interest in the collateral is transferred to a new secured party. - The original secured party relinquishes all rights to the collateral. - All future actions related to the financing statement will be handled by the new secured party. title: Partial Assignment type: string secured_parties: anyOf: - description: >- An enumeration of secured parties implicated in the lien filing process. items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse title: Secured Parties type: array - description: Secured parties are not set yet for this assignment. title: Secured Parties Not Set type: 'null' default: null title: Secured Parties required: - type title: LienFilingUCC3FullAssignmentResponse (v1) type: object v1.LienFilingUCC3PartialAssignmentResponse: properties: type: const: PARTIAL description: >- Indicates a partial assignment of the lien filing. In a partial assignment: - Only a portion of the interest in the collateral is transferred to a new secured party. - The original secured party retains some rights to the collateral. - Both the original and new secured parties may have rights to take actions related to the financing statement, but only for their respective portions of the collateral. title: Partial Assignment type: string secured_parties: anyOf: - description: >- An enumeration of secured parties implicated in the lien filing process. items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse title: Secured Parties type: array - description: Secured parties are not set yet for this assignment. title: Secured Parties Not Set type: 'null' default: null title: Secured Parties collateral_statements: anyOf: - $ref: '#/components/schemas/v1.LienFilingCollateralStatementText' - $ref: >- #/components/schemas/v1.LienFilingCollateralStatementAttachmentsResponse - description: >- When updating the record with `nul`, it will respect the existing server value for the `collateral_statements` field of the filing document, causing no changes to this field. title: Collateral Statements Omitted type: 'null' default: null description: >- This field allows for collateral statements to be provided either as plain text or as one or more document attachments, offering flexibility in how detailed information or evidence related to the lien's collateral is presented. > **NOTE:** Attachments for lien filing submissions are managed through separate attachment management routes specific to lien filings. These routes allow for the upload, retrieval, and deletion of attachments associated with a lien filing. To include attachments in the collateral statements, set the `collateral_statements` field with `type="ATTACHMENTS"` and use the appropriate attachment management endpoints. examples: - collateral_statement_designation: null text: >- Commercial real estate located at 123 Business Blvd, Tech City, TX type: TEXT - attachments: - document_filename: Ford Mustang 1967 Convertible.pdf id: 65ef3e23-782d-4181-b6ad-a5626c77f829 - document_filename: collateral_statement_details.pdf id: d1abea53-8262-4756-9577-f03df011fc86 collateral_statement_designation: null type: ATTACHMENTS title: Collateral Statements required: - type title: LienFilingUCC3PartialAssignmentResponse (v1) type: object v1.LienFilingUCC3AddDebtorAmendmentResponse: description: >- Represents an amendment to add a debtor in a UCC-3 filing. This model is used to add a new debtor to an existing financing statement. It includes details about the debtor being added to the UCC-3 amendment. properties: type: const: ADD default: ADD description: >- Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement. title: Add Debtor type: string debtors: description: >- An enumeration of debtors implicated in the lien filing process. It is imperative to omit the debtor correlated with the business profile against which the lien is being filed. examples: - - capacity: ESTATE city: Springfield id: c226073d-a0dc-4b7e-8f94-e2b308f77e82 mailing_address: 123 Main St organization_name: Acme Inc organization_type: COOPERATIVE postal_code: '62701' role: Debtor state: IL type: ORGANIZATION items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse title: Debtors type: array required: - type title: LienFilingUCC3AddDebtorAmendmentResponse (v1) type: object v1.LienFilingUCC3EditDebtorAmendmentResponse: properties: type: const: EDIT default: EDIT description: >- Indicates that this is an edit debtor action for a UCC-3 filing. An edit debtor action is used to edit an existing debtor in the financing statement. title: Edit Debtor type: string amending_debtors: description: >- A list of debtors to be amended in the UCC-3 filing. Each entry contains the position of the debtor in the original filing and the new debtor information. items: $ref: '#/components/schemas/v1.LienFilingUCC3AmendingDebtorResponse' title: Amending Debtors type: array required: - type title: LienFilingUCC3EditDebtorAmendmentResponse (v1) type: object v1.LienFilingUCC3DeleteDebtorAmendmentResponse: properties: type: const: DELETE default: DELETE description: >- Indicates that this is a delete debtor action for a UCC-3 filing. A delete debtor action is used to delete an existing debtor in the financing statement. title: Delete Debtor type: string deleted_debtors: description: A list of the debtors to be deleted in the UCC-3 filing. items: anyOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse title: Deleted Debtor type: array required: - type title: LienFilingUCC3DeleteDebtorAmendmentResponse (v1) type: object v1.LienFilingUCC3AddSecuredPartyAmendmentResponse: properties: type: const: ADD default: ADD description: >- Indicates that this is an add debtor action for a UCC-3 filing. An add debtor action is used to add a new debtor to the financing statement. title: Add Debtor type: string secured_parties: description: >- An enumeration of secured parties implicated in the lien filing process. items: discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse title: Secured Parties type: array required: - type title: LienFilingUCC3AddSecuredPartyAmendmentResponse (v1) type: object v1.LienFilingUCC3EditSecuredPartyAmendmentResponse: properties: type: const: EDIT default: EDIT description: >- Indicates that this is an edit secured party action for a UCC-3 filing. An edit secured party action is used to edit an existing secured party in the financing statement. title: Edit Secured Party type: string amending_secured_parties: anyOf: - description: >- A list of secured parties to be amended in the UCC-3 filing. Each entry contains the position of the secured party in the original filing and the new secured party information. items: $ref: >- #/components/schemas/v1.LienFilingUCC3AmendingSecuredPartyResponse title: Amending Secured Parties type: array - description: The amending secured parties are not set yet. title: Amending Secured Parties Not Set type: 'null' default: null title: Amending Secured Parties required: - type title: LienFilingUCC3EditSecuredPartyAmendmentResponse (v1) type: object v1.LienFilingUCC3DeleteSecuredPartyAmendmentResponse: properties: type: const: DELETE default: DELETE description: >- Indicates that this is a delete secured party action for a UCC-3 filing. A delete secured party action is used to delete an existing secured party in the financing statement. title: Delete Secured Party type: string deleted_secured_parties: description: A list of the secured parties to be deleted in the UCC-3 filing. items: anyOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse title: Deleted Secured Parties type: array required: - type title: LienFilingUCC3DeleteSecuredPartyAmendmentResponse (v1) type: object v1.LienFilingCollateralAmendmentType: description: >- Enum representing the types of amendments that can be made to collateral in a lien filing. This enum defines the possible actions that can be taken when amending information about collateral in a lien filing. enum: - ADD - RESTATE - DELETE title: LienFilingCollateralAmendmentType type: string v1.LienFilingUCC3AmendingDebtorResponse: description: |- Represents a debtor being amended in a UCC-3 filing. Specifies the details of a debtor being modified in a UCC-3 filing. This encompasses the original debtor's identifier and the updated information. UCC-3 filings serve to amend previously submitted Uniform Commercial Code financing statements. properties: amending_debtor: anyOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse' - $ref: >- #/components/schemas/v1.LienFilingAssignedBusinessDebtorPartyResponse - $ref: >- #/components/schemas/v1.LienFilingAssignedPersonDebtorPartyResponse description: >- The debtor information to be amended. This can be either an organization or an individual debtor. title: Amending Debtor new_debtor: description: >- The new debtor information. This can be either an organization or an individual debtor. discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualDebtorPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationDebtorPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualDebtorPartyResponse' title: New Debtor required: - amending_debtor - new_debtor title: LienFilingUCC3AmendingDebtorResponse (v1) type: object v1.LienFilingUCC3AmendingSecuredPartyResponse: description: >- Defines a response model for a secured party undergoing amendment in a UCC-3 filing. This class encapsulates the information for a secured party being modified in a UCC-3 (Uniform Commercial Code - Amendment) filing. It contains the identifier of the secured party from the original filing, along with the new or updated secured party details. properties: amending_secured_party: anyOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse' description: The ID of the secured party to be amended. title: Amending Secured Party ID new_secured_party: description: >- The new secured party information. This can be either an organization or an individual secured party. discriminator: mapping: INDIVIDUAL: $ref: >- #/components/schemas/v1.LienFilingIndividualSecuredPartyResponse ORGANIZATION: $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse propertyName: type oneOf: - $ref: >- #/components/schemas/v1.LienFilingOrganizationSecuredPartyResponse - $ref: '#/components/schemas/v1.LienFilingIndividualSecuredPartyResponse' title: New Secured Party required: - amending_secured_party - new_secured_party title: LienFilingUCC3AmendingSecuredPartyResponse (v1) type: object securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ````