> ## 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. # Get Portfolio Item Snapshot Diff > Retrieves a diff between two snapshots of a portfolio item. The diff shows the changes between the from_snapshot and to_snapshot, including business information, liens, dockets, and website analysis changes. Args: format: The response format. Options: - json (default): Returns the full diff response with snapshots and changes - notifications: Returns notifications generated from the diff changes - json_patch: Returns only the JSON patch operations array ## OpenAPI ````yaml /api-reference/openapi.json get /portfolio/items/{item_id}/diff openapi: 3.1.0 info: title: baselayer-api-service version: 0.1.0 servers: - url: https://api.baselayer.com/ security: [] paths: /portfolio/items/{item_id}/diff: get: tags: - Portfolio Monitoring summary: Get Portfolio Item Snapshot Diff description: >- Retrieves a diff between two snapshots of a portfolio item. The diff shows the changes between the from_snapshot and to_snapshot, including business information, liens, dockets, and website analysis changes. Args: format: The response format. Options: - json (default): Returns the full diff response with snapshots and changes - notifications: Returns notifications generated from the diff changes - json_patch: Returns only the JSON patch operations array operationId: get_portfolio_item_snapshot_diff_portfolio_items__item_id__diff_get parameters: - name: item_id in: path required: true schema: type: string format: uuid title: The unique identifier of the portfolio item. description: >- The unique identifier of the portfolio item to get snapshot diff for. examples: - 412a49b5-7466-426b-bf1e-081b00b54576 - 9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5 description: >- The unique identifier of the portfolio item to get snapshot diff for. - name: from_snapshot_id in: query required: true schema: type: string format: uuid title: The source snapshot ID description: The unique identifier of the source snapshot for the diff. examples: - 412a49b5-7466-426b-bf1e-081b00b54576 - 9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5 description: The unique identifier of the source snapshot for the diff. - name: to_snapshot_id in: query required: true schema: type: string format: uuid title: The target snapshot ID description: The unique identifier of the target snapshot for the diff. examples: - 412a49b5-7466-426b-bf1e-081b00b54576 - 9d5a286e-a6d6-4d6c-a38e-8b7ea50accd5 description: The unique identifier of the target snapshot for the diff. - name: format in: query required: false schema: $ref: '#/components/schemas/DiffFormat' title: Response format description: The format of the response data. examples: - json - notifications - json_patch default: json description: The format of the response data. responses: '200': description: Successful Response content: application/json: schema: anyOf: - $ref: '#/components/schemas/v1.PortfolioItemSnapshotDiffResponse' - type: array items: $ref: >- #/components/schemas/v1.PortfolioMonitoringNotificationResponse - type: array items: oneOf: - $ref: '#/components/schemas/AddOperation' - $ref: '#/components/schemas/RemoveOperation' - $ref: '#/components/schemas/ReplaceOperation' - $ref: '#/components/schemas/MoveOperation' - $ref: '#/components/schemas/CopyOperation' - $ref: '#/components/schemas/CheckOperation' discriminator: propertyName: op mapping: add: $ref: '#/components/schemas/AddOperation' copy: $ref: '#/components/schemas/CopyOperation' move: $ref: '#/components/schemas/MoveOperation' remove: $ref: '#/components/schemas/RemoveOperation' replace: $ref: '#/components/schemas/ReplaceOperation' test: $ref: '#/components/schemas/CheckOperation' title: >- Response Get Portfolio Item Snapshot Diff Portfolio Items Item Id Diff Get '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: DiffFormat: type: string enum: - json - notifications - json_patch title: DiffFormat description: Format options for portfolio item snapshot diff responses. v1.PortfolioItemSnapshotDiffResponse: properties: from_snapshot: $ref: '#/components/schemas/v1.PortfolioItemSnapshotResponse' description: The source snapshot for the diff. to_snapshot: $ref: '#/components/schemas/v1.PortfolioItemSnapshotResponse' description: The target snapshot for the diff. json_patch: items: oneOf: - $ref: '#/components/schemas/AddOperation' - $ref: '#/components/schemas/RemoveOperation' - $ref: '#/components/schemas/ReplaceOperation' - $ref: '#/components/schemas/MoveOperation' - $ref: '#/components/schemas/CopyOperation' - $ref: '#/components/schemas/CheckOperation' discriminator: propertyName: op mapping: add: $ref: '#/components/schemas/AddOperation' copy: $ref: '#/components/schemas/CopyOperation' move: $ref: '#/components/schemas/MoveOperation' remove: $ref: '#/components/schemas/RemoveOperation' replace: $ref: '#/components/schemas/ReplaceOperation' test: $ref: '#/components/schemas/CheckOperation' type: array title: Json Patch description: The diff in JSON Patch format. changes: items: $ref: '#/components/schemas/v1.DiffChangeResponse' type: array title: Changes description: The human-readable changes extracted from the diff. type: object required: - from_snapshot - to_snapshot - json_patch - changes title: PortfolioItemSnapshotDiffResponse (v1) description: Represents a portfolio item snapshot diff response. v1.PortfolioMonitoringNotificationResponse: description: Represents a notification for a portfolio item. properties: message: $ref: '#/components/schemas/v1.StructuredText' description: The message of the notification. notifiable_attribute: $ref: '#/components/schemas/v1.NotifiableAttributes' description: The attribute that triggered the notification. required: - message - notifiable_attribute title: PortfolioMonitoringNotificationResponse (v1) type: object AddOperation: properties: op: type: string const: add title: Op path: type: string title: Path description: JSON Pointer path to the target location value: title: Value description: The value to add additionalProperties: false type: object required: - op - path - value title: AddOperation description: 'Add operation: adds a value to the target location.' examples: - op: add path: /servers/web3 value: status: healthy - op: add path: /services/- value: redis RemoveOperation: properties: op: type: string const: remove title: Op path: type: string title: Path description: JSON Pointer path to the target location additionalProperties: false type: object required: - op - path title: RemoveOperation description: 'Remove operation: removes the value at the target location.' examples: - op: remove path: /servers/web2 - op: remove path: /services/1 ReplaceOperation: properties: op: type: string const: replace title: Op path: type: string title: Path description: JSON Pointer path to the target location value: title: Value description: The replacement value additionalProperties: false type: object required: - op - path - value title: ReplaceOperation description: 'Replace operation: replaces the value at the target location.' examples: - op: replace path: /servers/web1/status value: degraded - op: replace path: /config/timeout value: 60 MoveOperation: properties: op: type: string const: move title: Op path: type: string title: Path description: JSON Pointer path to the target location from: type: string title: From description: JSON Pointer path to source location additionalProperties: false type: object required: - op - path - from title: MoveOperation description: 'Move operation: moves a value from one location to another.' examples: - from: /servers/web1 op: move path: /archive/web1 - from: /config/old_setting op: move path: /config/new_setting CopyOperation: properties: op: type: string const: copy title: Op path: type: string title: Path description: JSON Pointer path to the target location from: type: string title: From description: JSON Pointer path to source location additionalProperties: false type: object required: - op - path - from title: CopyOperation description: 'Copy operation: copies a value from one location to another.' examples: - from: /servers/web1 op: copy path: /servers/web1-backup - from: /config/template op: copy path: /config/instance1 CheckOperation: properties: op: type: string const: test title: Op path: type: string title: Path description: JSON Pointer path to the target location value: title: Value description: The value to test against additionalProperties: false type: object required: - op - path - value title: CheckOperation description: >- Test operation: tests that a value at the target location equals a specified value. Note: Renamed from TestOperation to avoid pytest collection warnings. examples: - op: test path: /servers/web1/status value: healthy - op: test path: /version value: 1.2.3 HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError v1.PortfolioItemSnapshotResponse: properties: id: type: string format: uuid title: Id description: The unique identifier of the snapshot. portfolio_item_id: type: string format: uuid title: Portfolio Item Id description: >- The unique identifier of the portfolio item this snapshot belongs to. attributes: items: $ref: '#/components/schemas/MonitorableAttributes' type: array title: Attributes description: The attributes that were monitored when the snapshot was created. default: [] schema_version: type: integer title: Schema Version description: The schema version of the snapshot data. data: oneOf: - $ref: '#/components/schemas/v1.BusinessPortfolioItemSnapshotData' - $ref: '#/components/schemas/v1.PersonPortfolioItemSnapshotData' title: Data description: >- The snapshot data containing business information, liens, dockets, and website analysis. discriminator: propertyName: type mapping: Business: $ref: '#/components/schemas/v1.BusinessPortfolioItemSnapshotData' Person: $ref: '#/components/schemas/v1.PersonPortfolioItemSnapshotData' created_at: type: string format: date-time title: Created At description: When the snapshot was created. additionalProperties: true type: object required: - id - portfolio_item_id - schema_version - data - created_at title: PortfolioItemSnapshotResponse (v1) description: Represents a portfolio item snapshot response. v1.DiffChangeResponse: properties: path: type: string title: Path description: The path of the change operation: $ref: '#/components/schemas/JSONPatchOperationType' description: The operation that was performed old_value: title: Old Value description: The old value of the change new_value: title: New Value description: The new value of the change changed_at: type: string format: date-time title: Changed At description: The date and time the change was made type: object required: - path - operation - old_value - new_value - changed_at title: DiffChangeResponse (v1) description: Represents a change in a diff. v1.StructuredText: description: >- This class represents a structured text in the application. StructuredText is used to annotate individual parts of the text with semantic types. This is helpful to the UI for stylized rendering. It provides a way to structure the text in a way that can be easily understood and manipulated by the UI. properties: components: description: >- The structured text annotates individual parts of the text with semantic types, which is helpful to the UI for stylized rendering. items: $ref: '#/components/schemas/v1.TextComponent' title: An array of components that form the structured text type: array text: description: >- The same content as found in the components, but without any styling. readOnly: true title: A plain text representation of the content type: string required: - components - text title: StructuredText (v1) type: object v1.NotifiableAttributes: enum: - registration_health - new_registrations - addresses - officers - alternative_names - kyb_score - risk_score - identity_network - pep - ofac - liens - litigations - bankruptcies - website_analysis 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 MonitorableAttributes: description: The attributes that can be monitored. enum: - sos - liens - litigations - bankruptcies - website_analysis - pep - ofac - identity_network title: MonitorableAttributes type: string v1.BusinessPortfolioItemSnapshotData: description: Represents the data of a business portfolio item snapshot. properties: type: const: Business description: The type of the portfolio item snapshot data. title: Type type: string business: $ref: '#/components/schemas/v1.BusinessResponse' description: The business associated with the snapshot. scores: description: The scores associated with the business in the snapshot. items: $ref: '#/components/schemas/v1.ScoreResponse' title: Scores type: array liens: anyOf: - items: $ref: '#/components/schemas/v1.LienFilingResponse' type: array - type: 'null' description: The liens associated with the business in the snapshot. title: Liens dockets: anyOf: - items: $ref: '#/components/schemas/v1.DocketResponse' type: array - type: 'null' description: The dockets associated with the business in the snapshot. title: Dockets bankruptcies: anyOf: - items: $ref: '#/components/schemas/v1.DocketResponse' type: array - type: 'null' description: The bankruptcies associated with the business in the snapshot. title: Bankruptcies business_website_analysis: anyOf: - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails' - type: 'null' description: The website analysis associated with the business in the snapshot. item_website_analysis: anyOf: - $ref: '#/components/schemas/v1.WebsiteAnalysisDetails' - type: 'null' description: >- The website analysis associated with the portfolio item in the snapshot. search_combinations: anyOf: - items: $ref: '#/components/schemas/v1.ApplicationDetailCombinationsResponse' type: array - type: 'null' description: >- The search combinations associated with the business in the snapshot. title: Search Combinations search_history: anyOf: - items: $ref: '#/components/schemas/v1.ApplicationVelocityResponse' type: array - type: 'null' description: The search history associated with the business in the snapshot. title: Search History required: - business - scores - liens - dockets - bankruptcies - business_website_analysis - item_website_analysis - search_combinations - search_history - type title: BusinessPortfolioItemSnapshotData (v1) type: object v1.PersonPortfolioItemSnapshotData: description: Represents the data of a person portfolio item snapshot. properties: type: const: Person description: The type of the portfolio item snapshot data. title: Type type: string person: $ref: '#/components/schemas/v1.PersonResponse' description: The person associated with the snapshot. liens: anyOf: - items: $ref: '#/components/schemas/v1.LienFilingResponse' type: array - type: 'null' description: The liens associated with the person in the snapshot. title: Liens dockets: anyOf: - items: $ref: '#/components/schemas/v1.DocketResponse' type: array - type: 'null' description: The dockets associated with the person in the snapshot. title: Dockets bankruptcies: anyOf: - items: $ref: '#/components/schemas/v1.DocketResponse' type: array - type: 'null' description: The bankruptcies associated with the person in the snapshot. title: Bankruptcies required: - person - liens - dockets - bankruptcies - type title: PersonPortfolioItemSnapshotData (v1) type: object JSONPatchOperationType: type: string enum: - add - remove - replace - move - copy - test title: JSONPatchOperationType description: Enumeration of valid JSON Patch operation types. v1.TextComponent: description: >- A TextComponent is a segment of text with a semantic type and optional hyperlink. It is used to structure and annotate text in a way that can be helpful for stylized rendering in a UI without forcing a particular style. Each TextComponent has a type (subject, value, state, etc.), the actual text content, and an optional URL that points to the entity the text describes. properties: type: $ref: '#/components/schemas/v1.SemanticType' description: The text component can describe subjects, values, states and more. title: The semantic type of the text component text: description: >- This is the text part that composes the whole sentence within the StructuredText. title: The actual string content of the text component type: string for: anyOf: - type: string - type: 'null' default: null description: >- The entity that the text describes. When present, it points to the entity that the text describes. title: The entity that the text describes. url: anyOf: - description: When present, it points to the entity that the text describes. format: uri minLength: 1 title: Hyperlink to the entity type: string - description: When not present, the text is presented in regular format. title: No hyperlink provided. type: 'null' default: null title: Url required: - type - text title: TextComponent (v1) type: object v1.BusinessResponse: description: >- Response model for business data. This model defines the complete structure for business-related API responses. properties: id: description: Unique identifier for the business. format: uuid title: Id type: string name: description: >- The name of the business, determined by the name found on the domestic registration. examples: - Levine-Santos title: Name type: string structure: anyOf: - $ref: '#/components/schemas/v1.BusinessStructure' - type: 'null' default: null description: The structure of the business. examples: - C_CORPORATION - LLC addresses: description: All addresses found associated with this business entity. items: $ref: '#/components/schemas/v1.AddressSummaryResponseWithSources' title: Addresses type: array phone_numbers: description: All phone numbers found associated with this business entity. examples: - - 251-829-8026 items: type: string title: Phone Numbers type: array email: anyOf: - type: string - type: 'null' default: null description: The main email found associated with this business entity. examples: - kathleenholmes@example.com title: Email website: anyOf: - type: string - type: 'null' default: null description: The website found associated with this business entity. examples: - http://www.cruz-adkins.net/ title: Website social_profiles: anyOf: - items: $ref: '#/components/schemas/v1.DiscoveredSocialProfile' type: array - type: 'null' default: null description: >- The list of social media profiles potentially associated with this business entity that were identified by searching the web. examples: - confidence: null found_on: [] metadata: null site: twitter url: https://twitter.com/michelle98 username: michelle98 title: Social Profiles reviews: anyOf: - items: $ref: '#/components/schemas/v1.DiscoveredReview' type: array - type: 'null' description: >- The list of customer reviews potentially associated with this business entity that were identified by searching the web. title: Reviews directory_listings: anyOf: - items: $ref: '#/components/schemas/v1.DirectoryListingResponse' type: array - type: 'null' description: >- Directory listings (BBB, Yelp, etc.) discovered during website analysis, including business category, contact info, and address. title: Directory Listings ein: anyOf: - type: string - type: 'null' default: null deprecated: true description: The EIN/TIN found associated with this business entity. examples: - '871888915' title: Ein incorporation_state: anyOf: - $ref: '#/components/schemas/v1.StateAbbreviation' - type: 'null' default: null description: The state in which the business first incorporated. examples: - HI incorporation_date: anyOf: - type: string format: date - type: 'null' default: null description: The date when the business first incorporated. examples: - '2011-11-27' title: Incorporation Date months_in_business: anyOf: - type: integer - type: 'null' default: null description: The number of months elapsed since the incorporation date. examples: - 256 title: Months In Business primary_address: anyOf: - $ref: '#/components/schemas/v1.AddressSummaryResponse' - type: 'null' default: null description: The primary address associated with the business entity. alternative_names: default: [] description: >- A list of alternative names (e.g. DBAs) found associated with the business entity. examples: - - Ramos, Garcia and Good items: type: string title: Alternative Names type: array registrations: description: The corporate registrations associated with the business entity. items: $ref: '#/components/schemas/v1.RegistrationResponse' title: Registrations type: array business_officers: description: The officers associated with the business entity. items: $ref: '#/components/schemas/v1.BusinessOfficerResponse' title: Business Officers type: array predicted_naics: default: [] deprecated: true description: The predicted NAICS code(s) for the business entity. items: $ref: '#/components/schemas/v1.PredictedNaicsResponse' title: Predicted Naics type: array watchlist_hits: default: [] description: The watchlist hits associated with the business entity. items: $ref: '#/components/schemas/v1.WatchlistHitResponse' title: Watchlist Hits type: array sec_registrations: default: [] description: >- SEC EDGAR registrations linked to this business. Empty when no SEC registration is linked. items: $ref: '#/components/schemas/v1.SecRegistrationResponse' title: Sec Registrations type: array url: description: The URL to the business details. examples: - >- https://api.baselayer.com/businesses/9083e7e2-1f6b-11ef-8f0f-1edb1b067314 format: uri maxLength: 2083 minLength: 1 title: Url type: string console_url: description: The URL to the business details in the console. examples: - >- https://console.baselayer.com/business/9083e7e2-1f6b-11ef-8f0f-1edb1b067314 format: uri maxLength: 2083 minLength: 1 title: Console Url type: string revenue: default: null deprecated: true description: >- Indicates that there is no recent revenue data available for the business. title: No revenue data type: 'null' phone_number: anyOf: - type: string - type: 'null' default: null deprecated: true description: The primary phone number found associated with the business. examples: - 955-714-3269 title: Phone Number address: anyOf: - type: string - type: 'null' deprecated: true description: The primary address associated with the business entity. examples: - 63788 Paige Lane Cooperfurt, MI 10037 readOnly: true title: Address required: - id - name - url - console_url - address title: BusinessResponse (v1) type: object v1.ScoreResponse: properties: type: $ref: '#/components/schemas/v1.ScoreType' description: The type of score. examples: - risk score: description: The score value. examples: - 95 title: Score type: number rating: description: The rating associated with the score. examples: - A - B title: Rating type: string required: - type - score - rating title: ScoreResponse (v1) type: object v1.LienFilingResponse: description: |- Contains detailed information about a lien filing, including the filing number, type, date, status, and associated business and search request. The model also links to any amendments and the involved parties. properties: id: description: The identifier of this lien filing record. format: uuid title: Id type: string state: $ref: '#/components/schemas/v1.StateAbbreviation' description: State abbreviation code where the lien is filed. examples: - CA filing_number: description: Sequential identifier assigned by the filing office. examples: - P98172 title: Filing Number type: string filing_type: description: Describes the nature of the filing. examples: - Lien for Loan Default title: Filing Type type: string filing_date: description: Official date when the lien was recorded. examples: - '2023-09-18' format: date title: Filing Date type: string lapse_date: description: The expiry date for the lien's claim on collateral. examples: - '2023-04-15' format: date title: Lapse Date type: string status: description: Reflects the current legal status of the lien. examples: - Under Appeal title: Status type: string number_of_pages: description: Reflects the volume of documentation for the lien filing. examples: - 14 title: Number Of Pages type: integer document_filename: anyOf: - description: >- When present, it indicates that a document is available for download; Use get_lien_filing_documents or get_lien_filing_documents_for_business_id to download the documents. examples: - docket_47182.pdf title: The downloadable liens document filename. type: string - description: No downloadable documents are available for this lien filing. title: The downloadable document is not available. type: 'null' default: null title: Document Filename parties: default: [] description: >- A list of parties associated with this lien filing, encompassing both debtors and secured parties. This relationship is critical for identifying all entities with a vested interest in the lien's terms and outcome. items: $ref: '#/components/schemas/v1.LienPartyResponse' title: Parties type: array amendments: default: [] description: >- A chronological list of amendments to this lien filing, detailing any continuations, terminations, or modifications. This historical record is fundamental for tracking the evolution and current standing of the lien. items: $ref: '#/components/schemas/v1.LienAmendmentResponse' title: Amendments type: array collateral_type: anyOf: - $ref: '#/components/schemas/v1.CollateralType' - type: 'null' default: null description: >- The classified type of collateral secured by this lien filing (e.g. blanket, all_receivables, real_property). Null when the collateral type has not been determined. collateral_statements: default: [] description: >- A sequence of collateral statements associated with this lien filing, enumerating the specific assets secured by the lien. The order of these statements can denote the priority of claims against the assets. items: $ref: '#/components/schemas/v1.LienCollateralStatementResponse' title: Collateral Statements type: array lien_amount: anyOf: - type: number - type: 'null' description: >- The total monetary amount owed for a tax lien filing. Null for non-tax filings. Serialized as a JSON number. examples: - 15432.5 title: Lien Amount last_updated_at: description: The date the lien filing record was last updated. format: date title: Last Updated At type: string match_level: anyOf: - $ref: '#/components/schemas/v1.MatchType' - type: 'null' default: null description: The match level of the lien filing to the business name search_entity_name: anyOf: - type: string - type: 'null' default: null description: The name of the entity that the lien filing matched to. title: Search Entity Name search_entity_type: anyOf: - $ref: '#/components/schemas/v1.BusinessOrPersonType' - type: 'null' default: null description: The type of the entity that the lien filing matched to. required: - id - state - filing_number - filing_type - filing_date - lapse_date - status - number_of_pages - last_updated_at title: LienFilingResponse (v1) type: object v1.DocketResponse: description: Represents a docket response. properties: id: description: ID of the docket format: uuid title: Id type: string docket_number: description: Unique identifier for the Docket in the given court system examples: - A19284 title: Docket Number type: string court: description: Court in which the docket was filed examples: - Supreme Court of Orange County title: Court type: string state: anyOf: - $ref: '#/components/schemas/v1.CourtStateAbbreviation' - type: 'null' default: null description: State where the court is located (US for federal courts) examples: - CA - NY - US division: anyOf: - type: string - type: 'null' default: null description: Which court division examples: - Civil Court Division title: Division judges: default: [] description: List of judges assigned to the docket examples: - - Honorable Paul Shaw items: type: string title: Judges type: array title: description: Title of the docket examples: - Doe v. City of New York title: Title type: string case_type: anyOf: - type: string - type: 'null' default: null description: Type of case examples: - Civil - Criminal - Bankruptcy title: Case Type status: anyOf: - type: string - type: 'null' default: null description: Status of the case examples: - Pending title: Status is_bankruptcy: description: Is the case a bankruptcy title: Is Bankruptcy type: boolean bankruptcy_type: anyOf: - $ref: '#/components/schemas/v1.BankruptcyType' - type: 'null' default: null description: If the docket is a bankruptcy, is it Chapter 7 or Chapter 11 examples: - Chapter 7 - Chapter 11 date_filed: default: '1900-01-01' description: >- Date the case was filed. In cases where the date is not provided, this will be set to 1900-01-01. format: date title: Date Filed type: string date_closed: anyOf: - type: string format: date - type: 'null' default: null description: Date the case was closed or terminated, if known title: Date Closed last_synced_at: anyOf: - format: date-time type: string - type: 'null' default: null description: Datetime the case was last refreshed title: Last Synced At parties: default: [] description: List of parties involved in the docket items: $ref: '#/components/schemas/v1.DocketParty' title: Parties type: array updates: default: [] description: List of updates to the docket items: $ref: '#/components/schemas/v1.DocketUpdate' title: Updates type: array match_level: anyOf: - $ref: '#/components/schemas/v1.MatchType' - type: 'null' default: null deprecated: true description: >- The match level of the docket to the entity's name. Deprecated in favor of match_confidence. search_entity_name: anyOf: - type: string - type: 'null' default: null description: The name of the entity that the docket matched to title: Search Entity Name search_entity_type: anyOf: - $ref: '#/components/schemas/v1.BusinessOrPersonType' - type: 'null' default: null description: The type of the entity that the docket matched to match_confidence: anyOf: - $ref: '#/components/schemas/v1.DocketMatchConfidenceResponse' - type: 'null' default: null description: >- Confidence level and signals that the docket is associated with the search subject. risk_level: anyOf: - $ref: '#/components/schemas/v1.RiskLevel' - type: 'null' default: null description: The risk level of the docket examples: - low - medium - high normalized_status: anyOf: - $ref: '#/components/schemas/v1.NormalizedDocketStatus' - type: 'null' default: null description: The normalized status of the docket examples: - open - closed required: - id - docket_number - court - title - is_bankruptcy title: DocketResponse (v1) type: object v1.WebsiteAnalysisDetails: properties: id: description: The ID of the Website Analysis request format: uuid title: Id type: string url: description: The website URL that was analyzed as part of the Search. examples: - http://www.warner.com/ format: uri minLength: 1 title: Url type: string redirects: anyOf: - $ref: '#/components/schemas/v1.WebsiteRedirectInfo' - type: 'null' default: null description: >- Redirect information for this website, if a cross-domain redirect was detected. examples: - is_redirect_url: true redirects_to: baselayer.com parked: anyOf: - type: boolean - type: 'null' description: >- A boolean indicating if the website is suspected of being a parked domain. examples: - true - false title: Parked email_deliverable: anyOf: - type: boolean - type: 'null' default: null description: >- A boolean indicating if the website is able to send and receive emails. examples: - true - false title: Email Deliverable phone_numbers: anyOf: - items: type: string type: array - type: 'null' default: null description: >- The list of phone numbers that were identified on the analyzed website. examples: - - 362-345-4551 - (872) 628-1402 title: Phone Numbers emails: anyOf: - items: type: string type: array - type: 'null' description: >- The list of email addresses that were identified on the analyzed website. examples: - - bennettamber@example.org - goldenshawn@example.com title: Emails social_profiles: anyOf: - items: $ref: '#/components/schemas/v1.SocialProfile' type: array - type: 'null' description: >- The list of social media profiles that were identified on the analyzed website. examples: - - site: twitter url: https://twitter.com/michelle98 username: michelle98 title: Social Profiles addresses: default: [] description: >- The list of mailing addresses that were identified on the analyzed website. items: $ref: '#/components/schemas/v1.AddressSummaryResponse' title: Addresses type: array people: anyOf: - items: $ref: '#/components/schemas/v1.WebsiteAnalysisPerson' type: array - type: 'null' description: The list of people identified on the analyzed website. examples: - - name: Jane Smith titles: - CEO - Co-Founder - name: John Doe titles: - CTO title: People website_build_status: anyOf: - $ref: '#/components/schemas/v1.WebsiteBuildStatus' - type: 'null' default: null description: The build status of the website. website_summary: anyOf: - type: string - type: 'null' default: null description: A summary of the business based on the analyzed website content. examples: - >- Howard Concrete Pumping Co., Inc. is a concrete pumping contractor serving the construction industry. The company specializes in concrete placement services for residential and commercial construction projects. They operate throughout the greater metropolitan area and have been providing reliable concrete pumping solutions for over 20 years. title: Website Summary console_url: description: The URL to the Website Analysis details in the console. examples: - >- https://console.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis format: uri maxLength: 2083 minLength: 1 title: Console Url type: string screenshot_url: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' default: null description: The URL to download the homepage screenshot of the analyzed website. examples: - >- https://api.baselayer.com/business/dde7c16a-1f7b-11ef-9425-1edb1b067314/website_analysis/screenshot title: Screenshot Url whois_record: anyOf: - $ref: '#/components/schemas/v1.WhoIsRecordResponse' - type: 'null' default: null description: The WHOIS record information for the analyzed website. ssl_validity: anyOf: - $ref: '#/components/schemas/v1.SSLValidityInfo' - type: 'null' default: null description: >- The SSL certificate validity information for the analyzed website, including fraud-relevant signals. examples: - cert_age_days: 185 certificate_type: EV days_until_expiry: 180 expiry_date: '2025-01-15T00:00:00' is_revoked: false is_self_signed: false is_valid: true is_wildcard: false issued_date: '2024-01-15T00:00:00' issuer: DigiCert Global Root CA key_size: 2048 reason: null subject: www.example.com tls_version: TLSv1.3 - cert_age_days: 395 certificate_type: DV days_until_expiry: -30 expiry_date: '2024-01-01T00:00:00' is_revoked: false is_self_signed: false is_valid: false is_wildcard: false issued_date: '2023-01-01T00:00:00' issuer: R3 key_size: 256 reason: CERTIFICATE_EXPIRED subject: expired.example.com tls_version: TLSv1.2 website_structure_metrics: anyOf: - $ref: '#/components/schemas/v1.WebsiteStructureMetrics' - type: 'null' default: null description: >- Website structure metrics including depth and breadth discovered during scraping. examples: - breadth: 15+ depth: 2+ - breadth: '5' depth: '1' - breadth: '1' depth: '0' required: - id - url - parked - emails - social_profiles - console_url title: WebsiteAnalysisDetails (v1) type: object v1.ApplicationDetailCombinationsResponse: description: Represents an application detail combinations response. properties: created_at: description: The date and time when the search was created. examples: - '2026-08-31T10:31:07.677145' format: date-time title: Created At type: string name: description: The name inputted on the search. examples: - Clark PLC title: Name type: string address: description: The address inputted on the search. examples: - 63788 Paige Lane Cooperfurt, MI 10037 title: Address type: string tin: anyOf: - type: string - type: 'null' default: null description: The TIN inputted on the search. examples: - '123456789' title: Tin officer_names: default: [] description: The officer names inputted on the search. examples: - - Louis Schneider items: type: string title: Officer Names type: array required: - created_at - name - address title: ApplicationDetailCombinationsResponse (v1) type: object v1.ApplicationVelocityResponse: description: Represents an application velocity response. properties: created_at: description: The date and time when the application was submitted. examples: - '2026-08-24T10:31:07.676759' format: date-time title: Created At type: string type: $ref: '#/components/schemas/v1.OrganizationType' description: The type of organization that submitted the application. examples: - community_bank - credit_union team: anyOf: - $ref: '#/components/schemas/v1.OrganizationTeam' - type: 'null' default: null description: The team within the organization that submitted the application. examples: - compliance - risk product: anyOf: - $ref: '#/components/schemas/v1.OrganizationProduct' - type: 'null' default: null description: The financial product type for which the application was submitted. examples: - credit - working_capital required: - created_at - type title: ApplicationVelocityResponse (v1) type: object v1.PersonResponse: properties: id: description: The unique identifier of the person examples: - 3605eec5-940f-4d54-9d48-da1cffe940ac format: uuid title: Id type: string first_name: description: The first name of the person examples: - John - Jane title: First Name type: string last_name: description: The last name of the person examples: - Doe - Smith title: Last Name type: string ssn: description: The social security number of the person examples: - XXXXX1234 title: Ssn type: string middle_name: anyOf: - type: string - type: 'null' default: null description: The middle name of the person examples: - Michael - James - T title: Middle Name phone_number: anyOf: - type: string - type: 'null' default: null description: The phone number of the person in E164 format examples: - '+17075489914' - '+442071838750' title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: The email address of the person examples: - johndoe@example.com - janesmith@example.com title: Email date_of_birth: anyOf: - type: string format: date - type: 'null' default: null description: The date of birth of the person examples: - '1990-01-15' title: Date Of Birth gender: anyOf: - $ref: '#/components/schemas/v1.Gender' - type: 'null' default: null description: The gender of the person examples: - M - F marital_status: anyOf: - $ref: '#/components/schemas/v1.MaritalStatus' - type: 'null' default: null description: The marital status of the person examples: - married - single suffix: anyOf: - type: string - type: 'null' default: null description: The suffix of the person examples: - Jr. - Sr. title: Suffix title: anyOf: - type: string - type: 'null' default: null description: The title of the person examples: - Mr. - Mrs. title: Title created_at: description: When the person record was created examples: - '2025-01-15T12:00:00Z' format: date-time title: Created At type: string updated_at: anyOf: - format: date-time type: string - type: 'null' default: null description: When the person record was last updated examples: - '2025-01-15T12:00:00Z' title: Updated At dockets: default: [] description: The dockets associated with the person items: $ref: '#/components/schemas/v1.DocketResponse' title: Dockets type: array liens: default: [] description: The liens associated with the person items: $ref: '#/components/schemas/v1.LienFilingResponse' title: Liens type: array watchlist_hits: default: [] description: The watchlist hits associated with the person. items: $ref: '#/components/schemas/v1.WatchlistHitResponse' title: Watchlist Hits type: array required: - id - first_name - last_name - ssn - created_at title: PersonResponse (v1) type: object v1.SemanticType: description: >- SemanticType is an enumeration of the different types of semantic segments that a text can have. It is used to structure and annotate text in a way that can be helpful for stylized rendering in a UI, without forcing a particular style. enum: - regular - subject - value - label - actor title: SemanticType 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.AddressSummaryResponseWithSources: 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 sources: description: The sources of the address. examples: - - SOS - Online items: $ref: '#/components/schemas/v1.EntitySource' title: Sources type: array uniqueItems: true required: - id - street - city - state - zip - latitude - longitude title: AddressSummaryResponseWithSources (v1) type: object v1.DiscoveredSocialProfile: properties: site: description: The type of social profile. enum: - linked_in:personal - linked_in:company - twitter - instagram - facebook - youtube - tiktok - pinterest - x examples: - instagram type: string username: description: The username of the social profile. examples: - certifiedpowerinc title: Username type: string confidence: anyOf: - $ref: '#/components/schemas/v1.ConfidenceLevel' - type: 'null' default: null description: The confidence level of the social profile. examples: - high metadata: anyOf: - $ref: '#/components/schemas/v1.DiscoveredInstagramMetadata' - $ref: '#/components/schemas/v1.DiscoveredLinkedInMetadata' - $ref: '#/components/schemas/v1.DiscoveredFacebookMetadata' - $ref: '#/components/schemas/v1.DiscoveredXMetadata' - $ref: '#/components/schemas/v1.DiscoveredYouTubeMetadata' - $ref: '#/components/schemas/v1.DiscoveredTikTokMetadata' - $ref: '#/components/schemas/v1.DiscoveredPinterestMetadata' - type: 'null' default: null description: >- The metadata of the social profile. Based on the site of the social profile. title: Metadata found_on: description: >- Location(s) where this social profile was found: InputWebsite (user-provided website), FoundWebsite (discovered website) examples: - - FOUND_WEBSITE - - INPUT_WEBSITE - FOUND_WEBSITE items: enum: - INPUT_WEBSITE - FOUND_WEBSITE type: string title: Found On type: array uniqueItems: true url: description: The URL of the social profile. examples: - https://www.instagram.com/certifiedpowerinc readOnly: true title: Url type: string required: - site - username - url title: DiscoveredSocialProfile type: object v1.DiscoveredReview: properties: source: anyOf: - $ref: '#/components/schemas/v1.ReviewSource' - type: 'null' default: null description: The source of the review. examples: - yelp url: description: The URL of the review. examples: - https://www.yelp.com/biz/certified-power-inc-mundelein title: Url type: string confidence: anyOf: - $ref: '#/components/schemas/v1.ConfidenceLevel' - type: 'null' default: high description: The confidence level that this review is for the business. examples: - high rating: anyOf: - maximum: 5 minimum: 0 type: number - type: 'null' default: null description: The numeric rating of the review (e.g., 4.5 out of 5). examples: - 4.5 title: Rating volume: anyOf: - type: integer minimum: 0 - type: 'null' default: null description: The number of reviews. examples: - 23 title: Volume summary: anyOf: - type: string - type: 'null' default: null description: >- Overall summary of the reviews and general sentiment towards the business. examples: - >- 5 reviews mention that the service was great and the owner was very helpful. title: Summary phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number address: anyOf: - type: string - type: 'null' default: null description: Business address if found in profile examples: - 123 Main St, Anytown, USA title: Address business_website: anyOf: - type: string - type: 'null' default: null description: Business website if found in profile examples: - https://www.example.com title: Business Website reviews: description: Individual reviews for this business. items: $ref: '#/components/schemas/v1.ReviewDetail' title: Reviews type: array metadata: anyOf: - $ref: '#/components/schemas/v1.GoogleReviewMetadata' - type: 'null' default: null description: >- Platform-specific metadata for the review. Currently only populated for Google reviews. required: - url title: DiscoveredReview type: object v1.DirectoryListingResponse: description: >- A business listing discovered on a directory/aggregator site (BBB, Yelp, etc.). This is the public schema representation of directory listing data. Shadowed from the internal transient model to keep the OpenAPI spec stable and decoupled from internal IPC models. properties: source: anyOf: - type: string - type: 'null' default: null description: Directory domain where the listing was found. examples: - bbb.org - yelp.com - yellowpages.com title: Source url: anyOf: - type: string - type: 'null' default: null description: URL of the directory page that was scraped. examples: - >- https://www.bbb.org/us/ca/modesto/profile/plumber/joes-plumbing-1234 title: Url category: anyOf: - type: string - type: 'null' default: null description: Business category assigned by the directory site. examples: - Plumbing Contractor - Italian Restaurant - Moving Company title: Category business_name: anyOf: - type: string - type: 'null' default: null description: Business name as listed on the directory (may be a DBA). examples: - Joe's Plumbing & Heating title: Business Name phone_number: anyOf: - type: string - type: 'null' default: null description: Phone number from the directory listing. title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Email address from the directory listing. title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Website URL listed on the directory page for the business. title: Business Website address: anyOf: - type: string - type: 'null' default: null description: Physical address from the directory listing. title: Address people: description: Officers, principals, or key people listed on the directory page. items: $ref: '#/components/schemas/v1.DirectoryListingPerson' title: People type: array title: DirectoryListingResponse (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.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.RegistrationResponse: description: Response model for corporate registration data. properties: id: description: The unique identifier of the corporate registration. format: uuid title: Id type: string name: description: The name on the registration. examples: - Garcia, Hernandez and Woods title: Name type: string issue_date: anyOf: - type: string format: date - type: 'null' default: null description: The date the registration was issued. examples: - '2024-01-01' title: Issue Date inactive_date: anyOf: - type: string format: date - type: 'null' description: The date the registration became inactive. examples: - '2024-06-01' title: Inactive Date dissolution_date: anyOf: - type: string format: date - type: 'null' default: null description: The date the registration was dissolved in the given state. examples: - '2024-06-01' title: Dissolution Date file_number: description: The file number of the registration. examples: - '867124' title: File Number type: string state: $ref: '#/components/schemas/v1.StateAbbreviation' description: The state in which the registration was filed. examples: - AZ address: anyOf: - $ref: '#/components/schemas/v1.AddressSummaryResponse' - type: 'null' default: null description: The address associated with the registration. registration_type: anyOf: - $ref: '#/components/schemas/v1.CorporateRegistrationDomesticStatus' - type: 'null' default: null description: Whether the registration is domestic or foreign. examples: - domestic - foreign - unknown status: $ref: '#/components/schemas/v1.CorporateRegistrationStatus' description: >- Status field indicating whether the corporate registration filing is active or inactive. examples: - active - inactive - unknown standing: anyOf: - type: string - type: 'null' default: null description: The standing of the registration. examples: - In Good Standing - Inactive - Dissolved title: Standing registered_agent: anyOf: - $ref: '#/components/schemas/v1.CorporateRegistrationAgentResponse' - type: 'null' default: null description: The Registered Agent listed on the Registration. officers: default: [] description: The officers listed on the registration. items: $ref: '#/components/schemas/v1.RegistrationOfficerResponse' title: Officers type: array required: - id - name - file_number - state - status title: RegistrationResponse (v1) type: object v1.BusinessOfficerResponse: description: Response model for business officer data. properties: name: description: The name of the officer. examples: - Philip Mcguire title: Name type: string titles: default: [] description: The titles associated with the officer. examples: - - CEO - Founder items: type: string title: Titles type: array states: default: [] description: The states where the officer is registered. examples: - - CA - NY items: $ref: '#/components/schemas/v1.StateAbbreviation' title: States type: array sources: description: The sources of the officer. examples: - - SOS - Online items: $ref: '#/components/schemas/v1.EntitySource' title: Sources type: array uniqueItems: true required: - name title: BusinessOfficerResponse (v1) type: object v1.PredictedNaicsResponse: properties: code: description: The predicted NAICS code for the business. examples: - '336111' title: Code type: string title: description: The title of the predicted NAICS code. examples: - Automobile Manufacturing title: Title type: string accuracy: anyOf: - type: number - type: 'null' default: null description: The accuracy of the NAICS code prediction. examples: - 1 - 0.4 title: Accuracy keywords: anyOf: - items: type: string type: array - type: 'null' default: null description: >- Any keywords associated with the NAICS code to indicate area of business activity. examples: - - Automobiles - Manufacturing - Cars - Trucks title: Keywords mcc_codes: anyOf: - items: $ref: '#/components/schemas/v1.MCC' type: array - type: 'null' default: null description: List of MCC codes associated with the NAICS code. title: Mcc Codes sic_codes: anyOf: - items: $ref: '#/components/schemas/v1.SICCode' type: array - type: 'null' default: null description: List of SIC codes associated with the NAICS code. title: Sic Codes risk_level: anyOf: - $ref: '#/components/schemas/v1.RiskLevel' - type: 'null' default: null description: The risk level associated with the NAICS code. examples: - low - medium - high reasoning: anyOf: - type: string - type: 'null' default: null description: >- Explanation of why this specific NAICS code was chosen for the business. examples: - >- Based on homepage content mentioning automobile manufacturing and assembly processes. - >- Reviews and social profiles consistently reference restaurant and food service operations. title: Reasoning required: - code - title title: PredictedNaicsResponse (v1) type: object v1.WatchlistHitResponse: properties: code: description: The code of the watchlist data source. examples: - DMF title: Code name: $ref: '#/components/schemas/v1.WatchlistDataSource' description: The name of the watchlist data source. examples: - Death Master File count: description: The number of hits found in the watchlist data source. examples: - 1 - 0 - 5 title: Count type: integer details: anyOf: - items: additionalProperties: true type: object type: array - type: 'null' default: [] description: The details of the watchlist hits. examples: - - address: 123 Main St date_of_birth: '1980-01-01' name: John Doe title: Details required: - code - name - count title: WatchlistHitResponse (v1) type: object v1.SecRegistrationResponse: description: SEC EDGAR details for a single SEC registration linked to this business. properties: cik: description: SEC Central Index Key assigned to the registrant. examples: - '320193' title: Cik type: string tickers: description: All stock ticker symbols for this registrant. examples: - - NTDOY - - NTDOF items: type: string title: Tickers type: array uniqueItems: true exchanges: description: All exchanges this registrant's securities are listed on. examples: - - OTC items: type: string title: Exchanges type: array uniqueItems: true sec_edgar_url: description: Direct link to this registrant's SEC EDGAR page. format: uri maxLength: 2083 minLength: 1 readOnly: true title: Sec Edgar Url type: string required: - cik - tickers - exchanges - sec_edgar_url title: SecRegistrationResponse type: object v1.ScoreType: enum: - fraud - risk - kyb title: ScoreType 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.CollateralType: description: Classifies the collateral grant on a lien filing. enum: - blanket - all_receivables - named_receivables - all_equipment - named_equipment - all_inventory - named_inventory - real_property - agricultural - other - not_applicable title: CollateralType type: string v1.LienCollateralStatementResponse: description: |- Represents the text descriptions of collateral pledged against a lien as recorded in a UCC filing. Each statement details the specific assets secured by the lien and is sorted by a 'sort_order' to maintain the intended sequence of claims. properties: text: description: >- A detailed description of the collateral that is subject to the lien. examples: - 2022 Blue Honda Civic title: Text type: string sort_order: description: >- An integer representing the display or priority order of the collateral statements. title: Sort Order type: integer required: - text - sort_order title: LienCollateralStatementResponse (v1) type: object v1.MatchType: enum: - NO_MATCH - SIMILAR - EXACT title: MatchType type: string v1.BusinessOrPersonType: enum: - Business - Person title: BusinessOrPersonType type: string v1.CourtStateAbbreviation: enum: - US - 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 - CN - VI - AE - AA - AP - MX title: CourtStateAbbreviation type: string v1.BankruptcyType: enum: - Chapter 7 - Chapter 9 - Chapter 11 - Chapter 12 - Chapter 13 - Chapter 15 title: BankruptcyType type: string v1.DocketParty: description: Represents a docket party. properties: id: description: The unique identifier of the docket party. format: uuid title: Id type: string name: description: The name of the docket party. title: Name type: string party_type: anyOf: - type: string - type: 'null' default: null description: Type of party examples: - Complaintant title: Party Type counsel: default: [] description: List of counsel representing the party examples: - - Robin Keller items: type: string title: Counsel type: array required: - id - name title: DocketParty (v1) type: object v1.DocketUpdate: description: Represents a docket update. properties: id: description: ID of the litigation format: uuid title: Id type: string title: anyOf: - type: string - type: 'null' default: null description: Update title examples: - Update 2 title: Title contents: anyOf: - type: string - type: 'null' default: null description: Update contents examples: - New details about the case. title: Contents date: anyOf: - type: string format: date - type: 'null' default: null description: Update date examples: - '2024-06-01' title: Date exhibits: default: [] description: List of exhibits items: $ref: '#/components/schemas/v1.DocketExhibit' title: Exhibits type: array required: - id title: DocketUpdate (v1) type: object v1.DocketMatchConfidenceResponse: description: |- How likely a docket involves the search subject: a confidence level plus the three signals it's built from. properties: confidence: $ref: '#/components/schemas/v1.ConfidenceLevel' description: The confidence level that this docket involves the search subject. examples: - high - medium - low name_match: $ref: '#/components/schemas/v1.MatchType' description: >- The degree to which the names associated with the docket match the name(s) of the search subject. examples: - NO_MATCH - SIMILAR - EXACT address_match: $ref: '#/components/schemas/v1.DocketAddressMatchType' description: >- The degree to which the address information of the docket matches the addresses of the search subject. examples: - STATE - ADJACENT - FEDERAL_VENUE - NO_MATCH - UNKNOWN date_match: $ref: '#/components/schemas/v1.DocketDateMatchType' description: >- The consistency between the docket's filing date and the date when the search subject was legally capable of being a party in the docket (e.g. the date of incorporation). examples: - CONSISTENT - INCONSISTENT - UNKNOWN required: - confidence - name_match - address_match - date_match title: DocketMatchConfidenceResponse (v1) type: object v1.RiskLevel: enum: - high - medium - low - no_risk title: RiskLevel type: string v1.NormalizedDocketStatus: enum: - open - closed title: NormalizedDocketStatus type: string v1.WebsiteRedirectInfo: properties: is_redirect_url: description: Indicates that this website performs a cross-domain redirect. examples: - true title: Is Redirect Url type: boolean redirects_to: description: The domain this website redirects to. examples: - baselayer.com title: Redirects To type: string required: - is_redirect_url - redirects_to title: WebsiteRedirectInfo (v1) type: object v1.SocialProfile: properties: site: description: The type of social profile. enum: - linked_in:personal - linked_in:company - twitter - instagram - facebook - youtube - tiktok - pinterest - x examples: - instagram type: string username: description: The username of the social profile. examples: - certifiedpowerinc title: Username type: string url: description: The URL of the social profile. examples: - https://www.instagram.com/certifiedpowerinc readOnly: true title: Url type: string required: - site - username - url title: SocialProfile type: object v1.WebsiteAnalysisPerson: properties: name: type: string title: Name titles: items: type: string title: Titles type: array uniqueItems: true required: - name - titles title: WebsiteAnalysisPerson type: object v1.WebsiteBuildStatus: enum: - coming_soon - inactive - active title: WebsiteBuildStatus type: string v1.WhoIsRecordResponse: properties: domain_created_at: anyOf: - format: date-time type: string - type: 'null' description: The date and time when the domain was first registered. examples: - '2020-05-15T10:30:00Z' title: Domain Created At domain_age_months: anyOf: - type: integer - type: 'null' default: null description: The age of the domain since its creation in months. examples: - 15 title: Domain Age Months domain_updated_at: anyOf: - format: date-time type: string - type: 'null' description: The date and time when the domain registration was last updated. examples: - '2023-06-01T14:45:00Z' title: Domain Updated At domain_expires_at: anyOf: - format: date-time type: string - type: 'null' description: The date and time when the domain registration is set to expire. examples: - '2025-05-15T10:30:00Z' title: Domain Expires At registrar: anyOf: - type: string - type: 'null' description: The name of the domain registrar. examples: - Example Registrar Inc. title: Registrar required: - domain_created_at - domain_updated_at - domain_expires_at - registrar title: WhoIsRecordResponse (v1) type: object v1.SSLValidityInfo: description: |- SSL certificate information with fraud-relevant signals. is_valid semantics: True: Certificate is valid and trusted False: Certificate is definitively invalid (expired, untrusted, revoked, etc.) None: Cannot determine (connection failed, timeout, non-HTTPS) properties: is_valid: anyOf: - type: boolean - type: 'null' default: null description: >- Whether the SSL certificate is valid (True=valid, False=invalid, None=indeterminate) title: Is Valid reason: anyOf: - $ref: '#/components/schemas/v1.SSLInvalidReason' - type: 'null' default: null description: Reason if SSL certificate is invalid or indeterminate examples: - CERTIFICATE_EXPIRED - HOSTNAME_MISMATCH - SELF_SIGNED - UNABLE_TO_CONNECT issuer: anyOf: - type: string - type: 'null' default: null description: Certificate issuer (CA) common name examples: - DigiCert Global Root CA - R3 title: Issuer subject: anyOf: - type: string - type: 'null' default: null description: Certificate subject common name examples: - www.example.com - '*.example.com' title: Subject issued_date: anyOf: - format: date-time type: string - type: 'null' default: null description: When the certificate was issued title: Issued Date expiry_date: anyOf: - format: date-time type: string - type: 'null' default: null description: When the certificate expires title: Expiry Date days_until_expiry: anyOf: - type: integer - type: 'null' default: null description: Days until certificate expires (negative if expired) examples: - 365 - 30 - -5 title: Days Until Expiry cert_age_days: anyOf: - type: integer - type: 'null' default: null description: Days since certificate was issued examples: - 180 - 30 - 5 title: Cert Age Days certificate_type: anyOf: - $ref: '#/components/schemas/v1.SSLCertificateType' - type: 'null' default: null description: >- Certificate validation level (DV=Domain only, OV=Organization verified, EV=Extended validation) examples: - DV - EV is_wildcard: anyOf: - type: boolean - type: 'null' default: null description: Whether this is a wildcard certificate (*.example.com) title: Is Wildcard key_size: anyOf: - type: integer - type: 'null' default: null description: Public key size in bits examples: - 2048 - 4096 - 256 title: Key Size tls_version: anyOf: - $ref: '#/components/schemas/v1.TLSVersion' - type: 'null' default: null description: TLS protocol version used examples: - TLSv1.2 - TLSv1.3 is_self_signed: anyOf: - type: boolean - type: 'null' default: null description: Whether the certificate is self-signed (not trusted by a CA) title: Is Self Signed is_revoked: anyOf: - type: boolean - type: 'null' default: null description: Whether the certificate has been revoked (via OCSP check) title: Is Revoked title: SSLValidityInfo type: object v1.WebsiteStructureMetrics: description: |- Website structure metrics discovered during scraping. Formatted as strings for display: - depth: "0", "1", or "2+" - breadth: actual count as string or "15+" properties: depth: description: >- Maximum depth reached: '0' (homepage only), '1' (one level), or '2+' (structured site) examples: - '0' - '1' - 2+ title: Depth type: string breadth: description: >- Total unique pages discovered: actual count or '15+' for substantial sites examples: - '5' - '12' - 15+ title: Breadth type: string required: - depth - breadth title: WebsiteStructureMetrics type: object v1.OrganizationType: enum: - neobank - community_bank - credit_union - regional_bank - national_bank - fintech - smb_lender - merchant_cash_advanced - processor - infrastructure - other title: OrganizationType type: string v1.OrganizationTeam: description: |- Enum class for the different departments within an organization. These values are associated with the `User` model and are set during the user onboarding flow. enum: - cSuite - risk - compliance - engineering - operations - innovation - other title: OrganizationTeam type: string v1.OrganizationProduct: description: |- Enum class for the different products within an organization. These values are associated with the `User` model and are determined during the user onboarding process. enum: - savings - credit - working_capital - equipment - cash_advance - payments - other title: OrganizationProduct type: string v1.Gender: enum: - M - F title: Gender type: string v1.MaritalStatus: enum: - married - single - divorced - widowed - separated - domestic_partner - civil_union - other title: MaritalStatus type: string 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 v1.EntitySource: enum: - SOS - Online title: EntitySource type: string v1.ConfidenceLevel: enum: - high - medium - low title: ConfidenceLevel type: string v1.DiscoveredInstagramMetadata: description: Instagram-specific metadata extracted from a verified business profile. properties: is_private: anyOf: - type: boolean - type: 'null' default: null description: Whether the Instagram account is private examples: - false - true title: Is Private is_business_account: anyOf: - type: boolean - type: 'null' default: null description: Whether this is an Instagram business account examples: - true - false title: Is Business Account has_business_address: anyOf: - type: boolean - type: 'null' default: null description: Whether the business address is displayed on the Instagram profile examples: - true - false title: Has Business Address bio: anyOf: - type: string - type: 'null' default: null description: Instagram bio/description content examples: - Professional roofing services since 2010 🏠 title: Bio followers_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed examples: - 1250 - 5000 title: Followers Count phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile examples: - contact@business.com title: Email address: anyOf: - type: string - type: 'null' default: null description: Business address if found in profile examples: - 123 Main St, Anytown, USA title: Address business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile examples: - https://www.business.com title: Business Website title: DiscoveredInstagramMetadata type: object v1.DiscoveredLinkedInMetadata: description: LinkedIn-specific metadata extracted from a verified business profile. properties: company_size_range: anyOf: - type: string - type: 'null' default: null description: >- Company size range as displayed on LinkedIn (e.g., '11-50 employees') examples: - 11-50 employees - 51-200 employees title: Company Size Range industry: anyOf: - type: string - type: 'null' default: null description: Industry classification from LinkedIn examples: - Construction - Financial Services title: Industry followers_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed examples: - 250 - 1500 title: Followers Count phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number bio: anyOf: - type: string - type: 'null' default: null description: LinkedIn bio/description content title: Bio email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile examples: - info@business.com title: Email number_of_employees: anyOf: - type: integer - type: 'null' default: null description: Number of employees (LinkedIn only) examples: - 25 - 150 title: Number Of Employees business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile examples: - https://www.business.com title: Business Website title: DiscoveredLinkedInMetadata type: object v1.DiscoveredFacebookMetadata: description: Facebook-specific metadata extracted from a verified business profile. properties: is_business_page: anyOf: - type: boolean - type: 'null' default: null description: Whether this is a Facebook business page vs personal profile title: Is Business Page has_reviews: anyOf: - type: boolean - type: 'null' default: null description: Whether the Facebook page has customer reviews title: Has Reviews check_ins_count: anyOf: - type: integer - type: 'null' default: null description: Number of check-ins at this business location title: Check Ins Count followers_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed title: Followers Count bio: anyOf: - type: string - type: 'null' default: null description: Facebook bio/description content title: Bio phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile title: Phone Number address: anyOf: - type: string - type: 'null' default: null description: Business address if found in profile title: Address email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile title: Business Website title: DiscoveredFacebookMetadata type: object v1.DiscoveredXMetadata: description: Twitter/X-specific metadata extracted from a verified business profile. properties: is_verified: anyOf: - type: boolean - type: 'null' default: null description: Whether the Twitter/X account is verified examples: - true - false title: Is Verified follower_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed examples: - 1500 - 10000 title: Follower Count bio: anyOf: - type: string - type: 'null' default: null description: Twitter/X bio/description content examples: - Leading provider of construction services in the NYC area title: Bio joined_date: anyOf: - type: string - type: 'null' default: null description: When the account joined Twitter/X (e.g., 'Joined February 2010') examples: - Joined February 2010 - Joined March 2015 title: Joined Date address: anyOf: - type: string - type: 'null' default: null description: Business address if found in profile examples: - 123 Main St, Anytown, USA title: Address phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile examples: - contact@business.com title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile examples: - https://www.business.com title: Business Website title: DiscoveredXMetadata type: object v1.DiscoveredYouTubeMetadata: description: YouTube-specific metadata extracted from a verified business channel. properties: is_verified: anyOf: - type: boolean - type: 'null' default: null description: Whether the YouTube channel is verified examples: - true - false title: Is Verified subscriber_count: anyOf: - type: integer - type: 'null' default: null description: Number of subscribers if displayed examples: - 1200 - 15000 title: Subscriber Count channel_type: anyOf: - type: string - type: 'null' default: null description: Type of channel (e.g., 'Business', 'Brand', 'Personal') examples: - Business - Brand - Personal title: Channel Type has_business_email: anyOf: - type: boolean - type: 'null' default: null description: Whether business contact email is provided examples: - true - false title: Has Business Email channel_description: anyOf: - type: string - type: 'null' default: null description: Channel about/description content examples: - Weekly tutorials on home improvement and DIY projects title: Channel Description followers_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed examples: - 1200 - 15000 title: Followers Count phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile examples: - business@example.com title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile examples: - https://www.business.com title: Business Website title: DiscoveredYouTubeMetadata type: object v1.DiscoveredTikTokMetadata: description: TikTok-specific metadata extracted from a verified business profile. properties: is_verified: anyOf: - type: boolean - type: 'null' default: null description: Whether the TikTok account is verified examples: - true - false title: Is Verified is_business_account: anyOf: - type: boolean - type: 'null' default: null description: Whether this is a TikTok business account examples: - true - false title: Is Business Account follower_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed examples: - 5000 - 25000 title: Follower Count bio: anyOf: - type: string - type: 'null' default: null description: TikTok bio/description content examples: - Your trusted local contractor 🔨 Follow for tips! title: Bio has_business_website: anyOf: - type: boolean - type: 'null' default: null description: Whether a business website link is provided examples: - true - false title: Has Business Website phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile examples: - '+12125551234' title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile examples: - contact@business.com title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile examples: - https://www.business.com title: Business Website title: DiscoveredTikTokMetadata type: object v1.DiscoveredPinterestMetadata: description: Pinterest-specific metadata extracted from a verified business profile. properties: follower_count: anyOf: - type: integer - type: 'null' default: null description: Number of followers if displayed title: Follower Count monthly_views: anyOf: - type: integer - type: 'null' default: null description: Monthly views count if displayed title: Monthly Views bio: anyOf: - type: string - type: 'null' default: null description: Pinterest profile bio/description content title: Bio has_business_website: anyOf: - type: boolean - type: 'null' default: null description: Whether a business website link is provided title: Has Business Website phone_number: anyOf: - type: string - type: 'null' default: null description: Business phone number if found in profile title: Phone Number email: anyOf: - type: string - type: 'null' default: null description: Business email address if found in profile title: Email business_website: anyOf: - type: string - type: 'null' default: null description: Business website URL if found in profile title: Business Website title: DiscoveredPinterestMetadata type: object v1.ReviewSource: enum: - yelp - google - trustpilot - tripadvisor - other title: ReviewSource type: string v1.ReviewDetail: properties: username: description: The username of the reviewer. examples: - John Doe title: Username type: string text: description: The text of the review. examples: - This is a great review! title: Text type: string date: description: The date of the review. examples: - '2024-01-01' format: date title: Date type: string rating: description: The rating of the review. examples: - 5 title: Rating type: integer required: - username - text - date - rating title: ReviewDetail type: object v1.GoogleReviewMetadata: description: Google Maps-specific metadata for a discovered review. properties: open_state: anyOf: - type: string - type: 'null' default: null description: Current open/closed state from Google Maps. examples: - Open - Closed - Temporarily closed title: Open State operating_hours: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Operating hours data from Google Maps. title: Operating Hours description: anyOf: - type: string - type: 'null' default: null description: Business description from Google Maps. title: Description types: anyOf: - items: type: string type: array - type: 'null' default: null description: Business type tags from Google Maps. examples: - - Restaurant - Italian restaurant title: Types service_options: anyOf: - additionalProperties: true type: object - type: 'null' default: null description: Service options from Google Maps (e.g., dine-in, takeout). title: Service Options title: GoogleReviewMetadata type: object v1.DirectoryListingPerson: description: An officer, principal, or key person listed on a directory page. properties: name: type: string title: Name title: anyOf: - type: string - type: 'null' default: null title: Title required: - name title: DirectoryListingPerson type: object v1.CorporateRegistrationDomesticStatus: description: Status of the corporate registration filing. enum: - foreign - domestic - unknown title: CorporateRegistrationDomesticStatus type: string v1.CorporateRegistrationStatus: description: |- Status field indicating whether the corporate registration filing is active or inactive. enum: - active - inactive - unknown title: CorporateRegistrationStatus type: string v1.CorporateRegistrationAgentResponse: description: Response model for corporate registration agent data. properties: name: description: The name of the registered agent. examples: - Jeremy Crawford title: Name type: string address: anyOf: - $ref: '#/components/schemas/v1.AddressSummaryResponse' - type: 'null' default: null description: >- The AddressSummaryResponse of the address associated with the registered agent examples: - city: Andrewton cmra: false deliverable: false delivery_type: null id: ab237e72-7053-439d-ae5e-edbac59bf7cb latitude: 34.0522 longitude: -118.2437 rdi: null state: CA street: 3032 Mark Parks Andrewton, CA 27458 url: null zip: '27458' required: - name title: CorporateRegistrationAgentResponse (v1) type: object v1.RegistrationOfficerResponse: description: Response model for registration officer data. properties: name: description: The name of the officer. examples: - Tyler Johnson title: Name type: string titles: default: [] description: The titles associated with the officer. examples: - - CEO - Founder items: type: string title: Titles type: array required: - name title: RegistrationOfficerResponse (v1) type: object v1.MCC: description: Represents a Merchant Category Code (MCC). properties: code: description: The 4-digit MCC. title: Code type: string description: anyOf: - type: string - type: 'null' default: null description: Description of the MCC. title: Description mastercard_risk: anyOf: - type: boolean - type: 'null' default: null description: >- Indicates if there is a risk associated with Mastercard transactions. title: Mastercard Risk visa_risk_tier: anyOf: - $ref: '#/components/schemas/v1.VisaRiskTier' - type: 'null' default: null description: The Visa risk tier associated with this MCC. required: - code title: MCC type: object v1.SICCode: description: Represents a Standard Industrial Classification (SIC) code. properties: code: description: The 4-digit SIC code. title: Code type: string description: anyOf: - type: string - type: 'null' default: null description: Description of the SIC code. title: Description required: - code title: SICCode type: object v1.WatchlistDataSource: enum: - Death Master File - Department of Treasury, Office of Foreign Assets Control - Politically Exposed Persons - IRS Exempt Organizations List - FBI Wanted List - Department of Commerce, Consolidated Screening List - Consolidated Canadian Autonomous Sanctions List - HHS OIG List of Excluded Individuals/Entities - Baselayer Fraud Consortium title: WatchlistDataSource type: string 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.DocketExhibit: description: Represents a docket exhibit. properties: id: description: ID of the litigation format: uuid title: Id type: string title: description: Exhibit title examples: - Exhibit 1A title: Title type: string is_available: default: false description: Is the exhibit available title: Is Available type: boolean document_url: anyOf: - type: string - type: 'null' description: >- The document_url is a string that represents Docket Exhibit's document URL. readOnly: true title: Document Url required: - id - title - document_url title: DocketExhibit (v1) type: object v1.DocketAddressMatchType: description: |- Court-venue-vs-subject-state signal for docket match_confidence. Distinct from `AddressMatchType` (KYB/international address comparison, above) — different domain, different value set. enum: - STATE - ADJACENT - FEDERAL_VENUE - NO_MATCH - UNKNOWN title: DocketAddressMatchType type: string v1.DocketDateMatchType: description: |- Filing-date-vs-reference-date veto signal for docket match_confidence. enum: - CONSISTENT - INCONSISTENT - UNKNOWN title: DocketDateMatchType type: string v1.SSLInvalidReason: description: >- Reasons why an SSL certificate check failed or could not be determined. Used when is_valid is False (certificate invalid) or None (indeterminate). enum: - CERTIFICATE_EXPIRED - HOSTNAME_MISMATCH - SELF_SIGNED - REVOKED - UNTRUSTED_AUTHORITY - VERIFICATION_FAILED - NOT_HTTPS - CONNECTION_TIMED_OUT - UNABLE_TO_CONNECT - SERVER_DISCONNECTED - SERVER_ERROR - CONNECTION_ERROR title: SSLInvalidReason type: string v1.SSLCertificateType: description: >- Type of SSL certificate based on validation level. DV (Domain Validation): Only domain ownership verified - easiest to obtain OV (Organization Validation): Organization identity verified EV (Extended Validation): Extensive organization verification - highest trust enum: - DV - OV - EV - Unknown title: SSLCertificateType type: string v1.TLSVersion: description: TLS protocol version used for SSL connections. enum: - TLSv1.0 - TLSv1.1 - TLSv1.2 - TLSv1.3 - SSLv3 - Unknown title: TLSVersion type: string v1.VisaRiskTier: enum: - 1 - 2 - 3 title: VisaRiskTier type: integer securitySchemes: APIKeyHeader: type: apiKey in: header name: X-API-Key ````