> ## 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. # Lookup Initial Filing For Amendment > Resolve the initial financing statement a UCC-3 will amend, from the file number and file date the filer copies off the UCC-1. The search a filer must run before creating a UCC-3. Resolution is three-way: a UCC-1 the organization filed through Baselayer resolves to that submission; a filing known from the public record is claimed as an imported filing (creating the record if this is the first claim, exactly as `POST /lien_submissions/import` would); and a filing Baselayer cannot verify at all is reported as `not_found` — unless `allow_unverified` is set, in which case it is held as an unverified imported filing built from the details supplied here. Keep `allow_unverified` off until the filer has seen the `not_found` answer and confirmed they want to proceed anyway. The resolved filing is what `POST /lien_submissions/{filing_id}/amend` then targets. `warnings` flags a file date that disagrees with the matched filing, a date past its lapse date, or a filing that is no longer Active — none of them block the lookup. The file number is validated against the state's format where the format is known (length and character checks otherwise), and the file date must not be in the future nor predate the revised UCC Article 9 effective date (2001-07-01). Not available to sandbox applications: the lookup reads the real public record and can claim a filing off it, so there is nothing to simulate. ## OpenAPI ````yaml /api-reference/openapi.json post /lien_submissions/initial_filing_lookup openapi: 3.1.0 info: title: baselayer-api-service version: 0.1.0 servers: - url: https://api.baselayer.com/ security: [] paths: /lien_submissions/initial_filing_lookup: post: tags: - Lien Filing summary: Lookup Initial Filing For Amendment description: |- Resolve the initial financing statement a UCC-3 will amend, from the file number and file date the filer copies off the UCC-1. The search a filer must run before creating a UCC-3. Resolution is three-way: a UCC-1 the organization filed through Baselayer resolves to that submission; a filing known from the public record is claimed as an imported filing (creating the record if this is the first claim, exactly as `POST /lien_submissions/import` would); and a filing Baselayer cannot verify at all is reported as `not_found` — unless `allow_unverified` is set, in which case it is held as an unverified imported filing built from the details supplied here. Keep `allow_unverified` off until the filer has seen the `not_found` answer and confirmed they want to proceed anyway. The resolved filing is what `POST /lien_submissions/{filing_id}/amend` then targets. `warnings` flags a file date that disagrees with the matched filing, a date past its lapse date, or a filing that is no longer Active — none of them block the lookup. The file number is validated against the state's format where the format is known (length and character checks otherwise), and the file date must not be in the future nor predate the revised UCC Article 9 effective date (2001-07-01). Not available to sandbox applications: the lookup reads the real public record and can claim a filing off it, so there is nothing to simulate. operationId: >- lookup_initial_filing_for_amendment_lien_submissions_initial_filing_lookup_post requestBody: content: application/json: schema: $ref: '#/components/schemas/v1.LienInitialFilingLookupRequest' title: Initial Filing Lookup Request description: >- The initial financing statement details to resolve, as they appear on the UCC-1. examples: - state: IL filing_number: P98172 filing_date: '2023-01-15' allow_unverified: false required: true responses: '200': description: >- The lookup resolved (or reported `not_found`) without creating a record. content: application/json: schema: $ref: '#/components/schemas/v1.LienInitialFilingLookupResponse' '201': description: The lookup created an imported filing record and resolved to it. '402': description: >- The calling application is a sandbox application, which cannot claim filings from the public record, or the organization is locked. content: application/json: schema: anyOf: - $ref: '#/components/schemas/APIError' title: PaymentRequiredSandboxApplication description: >- Payment Required. Sandbox applications do not support this request. examples: - code: 500 message: >- Payment Required. Sandbox applications do not support this request. metadata: {} - $ref: '#/components/schemas/APIError' title: OrganizationLocked description: >- The organization is locked due to payment issues. Please update your payment information. examples: - code: 3004 message: >- The organization is locked due to payment issues. Please update your payment information. metadata: {} title: >- Response 402 Lookup Initial Filing For Amendment Lien Submissions Initial Filing Lookup Post '409': description: >- The organization already holds this lien as a filing made through Baselayer, or a concurrent request held it as an unverified attestation-based record. content: application/json: schema: anyOf: - $ref: '#/components/schemas/APIError' title: LienFilingAlreadyHeld description: >- This lien filing is already held by the organization as a Baselayer filing. examples: - code: 489 message: >- This lien filing is already held by the organization as a Baselayer filing. metadata: {} - $ref: '#/components/schemas/APIError' title: LienFilingHeldAsUnverifiedImport description: >- This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says. examples: - code: 491 message: >- This lien filing is already held by the organization as an unverified, attestation-based record, which carries no link to the public filing. Import cannot claim the public record over it — look the initial filing up instead to see what the public record now says. metadata: {} title: >- Response 409 Lookup Initial Filing For Amendment Lien Submissions Initial Filing Lookup Post '422': description: >- The public record filing is not a consensual UCC filing, or the request failed validation. content: application/json: schema: $ref: '#/components/schemas/APIError' title: CannotImportNonConsensualLienFiling description: >- Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements. examples: - code: 490 message: >- Only consensual lien filings can be imported. Statutory, judicial and tax liens are imposed on a debtor rather than granted by one, so they are not tracked as UCC financing statements. metadata: {} security: - APIKeyHeader: [] components: schemas: v1.LienInitialFilingLookupRequest: properties: state: $ref: '#/components/schemas/StateAbbreviation' title: Jurisdiction State description: >- The state abbreviation of the jurisdiction the initial financing statement is filed in. examples: - IL filing_number: type: string maxLength: 64 minLength: 1 title: Initial File Number description: >- The filing number the filing office assigned the initial financing statement (UCC-1) being amended. examples: - P98172 filing_date: type: string format: date title: Initial File Date description: >- The date the initial financing statement was filed. Cannot be in the future and cannot predate the revised UCC Article 9 effective date (2001-07-01). examples: - '2023-04-20' filing_name: anyOf: - type: string maxLength: 128 title: Filing Name description: >- A custom name for the filing record this lookup creates, when it creates one (only filer's reference). examples: - Acme Inc — 2023 equipment lien - type: 'null' title: No Filing Name provided. description: The filing name defaults to the filing number. title: Filing Name allow_unverified: type: boolean title: Allow an Unverified Filing description: >- When the filing cannot be found in Baselayer or the public record, whether to hold it anyway as an unverified imported filing built from the details supplied here. Off by default so an exploratory search creates nothing; set it only after the filer confirms the initial filing could not be verified. default: false additionalProperties: false type: object required: - state - filing_number - filing_date title: LienInitialFilingLookupRequest (v1) description: |- Request schema for resolving the initial financing statement a UCC-3 amends, from the details the filer copies off the UCC-1 (ENG-6940). The pair a jurisdiction identifies a lien by — state and filing number — drives the lookup; the file date cross-checks the match. Both are validated here with the same rules the console applies inline, so the amend flow cannot be entered with data the lookup never saw. v1.LienInitialFilingLookupResponse: properties: outcome: $ref: '#/components/schemas/LienInitialFilingLookupOutcome' title: Lookup Outcome description: >- Which kind of record the lookup resolved the initial financing statement to, or `not_found` when nothing matched and no unverified filing was requested. examples: - imported created: type: boolean title: Created description: >- Whether this lookup created the returned filing record, as opposed to resolving one the organization already held. warnings: items: $ref: '#/components/schemas/LienInitialFilingLookupWarning' type: array title: Warnings description: >- Non-blocking flags about the match: a file date that disagrees with the matched filing (`filing_date_mismatch`), a file date past the filing's lapse date (`filing_date_after_lapse_date`), a filing that no longer stands (`filing_not_active`), or an unverified import whose filing has since appeared in the public record (`public_record_available`). filing: anyOf: - oneOf: - $ref: '#/components/schemas/v1.LienFilingSubmissionUCC1Response' - $ref: '#/components/schemas/v1.LienFilingSubmissionImportedResponse' - type: 'null' title: No Filing Resolved description: >- Nothing matched and no unverified filing was requested; no record was created. title: Resolved Filing description: >- The filing the UCC-3 amendment can target: the organization's own submission when it filed the initial financing statement through Baselayer, or its imported filing record otherwise. type: object required: - outcome - created - warnings title: LienInitialFilingLookupResponse (v1) description: |- How the initial-filing lookup resolved, and the record a UCC-3 can now be created against via ``POST /lien_submissions/{filing_id}/amend``. 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. 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 LienInitialFilingLookupOutcome: type: string enum: - filed_via_baselayer - imported - imported_unverified - not_found title: LienInitialFilingLookupOutcome description: >- How an initial-filing lookup for a UCC-3 resolved (ENG-6940). The lookup starts a UCC-3 amendment from a `(state, filing number)` pair, and the outcome names which record the amendment can now target. LienInitialFilingLookupWarning: type: string enum: - filing_date_mismatch - filing_date_after_lapse_date - filing_not_active - public_record_available - secured_party_preferences_missing title: LienInitialFilingLookupWarning description: Non-blocking flags an initial-filing lookup raises about its match. 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.LienFilingSubmissionImportedResponse: 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 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 filing_type: const: UCC1 default: UCC1 description: >- Initial financing statement, which is the filing an imported lien is identified by. title: Filing Type type: string state: $ref: '#/components/schemas/StateAbbreviation' title: Jurisdiction State description: The state abbreviation of the jurisdiction the lien is filed in. examples: - IL status: $ref: '#/components/schemas/LienFilingStatus' title: Lien Status description: >- The lien's standing in the public record, derived from its amendment history and lapse date (UCC §9-515). examples: - Active imported_unverified: default: false description: >- Whether this filing is held from the details the caller supplied rather than verified against the public record. Its status, dates and parties are the caller's own claim, estimated under UCC §9-515 where the public record would otherwise answer. examples: - false title: Unverified Import type: boolean debtors: description: The debtors recorded against the lien in the public record. items: $ref: '#/components/schemas/v1.LienPartyResponse' title: Debtors type: array secured_parties: description: The secured parties recorded against the lien in the public record. items: $ref: '#/components/schemas/v1.LienPartyResponse' title: Secured Parties type: array amendments: description: >- The continuations, terminations, assignments and other amendments recorded against the lien in the public record. items: $ref: '#/components/schemas/v1.LienAmendmentResponse' title: Amendments type: array additionalProperties: false type: object required: - type title: LienFilingSubmissionImportedResponse (v1) description: >- Represents a lien filing an organization imported from the public record. Baselayer holds no submission of its own for these filings, so everything describing the lien — its status, parties and amendment history — is derived from the public corpus at read time rather than from an editable draft. 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 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 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.LienPartyResponse: description: >- Represents an entity involved in a lien as either a debtor or a secured party. This model captures common attributes and relationships of these parties. properties: id: description: The identifier of this lien filing record. format: uuid title: Id type: string role: $ref: '#/components/schemas/v1.LienPartyRole' description: >- Categorizes the party as either a debtor owing the debt or a secured party holding the collateral interest. examples: - Debtor name: description: >- Legal name of the party; crucial for due diligence and legal proceedings related to the lien. examples: - Louis Schneider title: Name type: string address: anyOf: - $ref: '#/components/schemas/v1.AddressSummaryResponse' - type: 'null' description: >- Address of the party; provides the physical location for legal notices or contact purposes. mailing_address: anyOf: - type: string - type: 'null' default: null description: >- Street of the party's address as written on the filing itself, when known. It may accompany `address` rather than replace it: `address` is the verified address record behind the party when there is one, and these components are what the filing says — the only address a party with no verified record has. examples: - 1 Market Street title: Mailing Address city: anyOf: - type: string - type: 'null' default: null description: >- City of the party's address as recorded on the filing itself; see `mailing_address`. examples: - San Francisco title: City state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' - type: 'null' default: null description: >- State of the party's address as recorded on the filing itself; see `mailing_address`. examples: - CA postal_code: anyOf: - type: string - type: 'null' default: null description: >- Postal code of the party's address as recorded on the filing itself; see `mailing_address`. examples: - '94105' title: Postal Code type: description: >- The type of lien party, indicating whether the party is an individual or an organization. A computed property that returns the role of the lien party. Note: This `type` property is planned to be deprecated in favor of the `role` field in future versions. examples: - individual - organization title: Type type: string required: - id - role - name - address - type title: LienPartyResponse (v1) type: object v1.LienAmendmentResponse: description: |- Represents a change or update to a lien filing, such as a continuation, termination, or assignment that affects the lien's validity or terms. properties: filing_number: description: The document filing number. examples: - H76162 title: Filing Number type: string filing_type: description: The document filing type. examples: - Notarized Letter title: Filing Type type: string filing_date: description: The date of the lien filing. examples: - '2023-11-27' format: date title: Filing Date type: string number_of_pages: description: Number of image pages in the library for this filing number. examples: - 4 title: Number Of Pages type: integer required: - filing_number - filing_type - filing_date - number_of_pages title: LienAmendmentResponse (v1) type: object 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.LienPartyRole: description: |- Enum class delineating the role of parties in a lien transaction as defined by the UCC. enum: - Debtor - Secured Party - Record Owner title: LienPartyRole type: string v1.AddressSummaryResponse: description: |- Response model for address summary data. This model defines the structure for address summary API responses. properties: id: description: Unique identifier for the address. format: uuid title: Id type: string street: description: Street name of the address. examples: - 913 Hendrix Gardens Suite 492 title: Street type: string city: description: City name of the address. examples: - Jasonfurt title: City type: string state: $ref: '#/components/schemas/v1.StateAbbreviation' description: State 2 letter abbreviation of the address. examples: - VA zip: description: Zip code of the address. examples: - '19773' title: Zip type: string latitude: description: Latitude of the address. examples: - 38.03012 title: Latitude type: number longitude: description: Longitude of the address. examples: - 78.47665 title: Longitude type: number rdi: anyOf: - $ref: '#/components/schemas/v1.AddressRDI' - type: 'null' default: null description: Residential Delivery Indicator of the address. examples: - Commercial deliverable: anyOf: - type: boolean - type: 'null' default: null description: Indicates whether the address is deliverable. examples: - false title: Deliverable cmra: anyOf: - type: boolean - type: 'null' default: null description: >- Indicates whether the address is a Commercial Mail Receiving Agency (CMRA). examples: - false title: Cmra url: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' default: null description: The URL to the address details. title: Url delivery_type: anyOf: - $ref: '#/components/schemas/v1.USPSDeliveryType' - type: 'null' default: null description: The USPS delivery type. examples: - STREET - FIRM required: - id - street - city - state - zip - latitude - longitude title: AddressSummaryResponse (v1) type: object v1.AddressRDI: enum: - Residential - Commercial title: AddressRDI type: string v1.USPSDeliveryType: description: |- Enum representing the different types of USPS delivery points. Used to classify addresses based on how mail is delivered to them. enum: - FIRM - GENERAL_DELIVERY - HIGH_RISE - POST_OFFICE - RURAL_ROUTE - STREET title: USPSDeliveryType type: string securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ````