> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lendflow.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clear Business UCC Filings

## Clear Business UCC Filings

Use Clear Business UCC Filings to evaluate whether the business appears as a debtor in UCC filings. This is distinct from the individual-entity block even though both Workflow Builder cards are labeled **Clear UCC Filings**.

The Workflow Builder card is labeled **Clear UCC Filings** (`clear_business_uccs`) and applies to a business entity. Its declared service is `clear_risk_inform_business_search`. The dashboard can also start `clear_risk_inform_business_report` after Search and display the report UCC debtor flag. Data Orchestration evaluates the Search result when this service is used in a template.

## Requirements

### Search

| Application field | Requirement | Notes |
| - | - | - |
| Business legal name | Required | Used by the prerequisite ID Confirm Business search. |
| Business city | Required | Used for address matching. |
| Business state | Required | Use a valid U.S. state code. |
| Business street and ZIP code | Optional | These fields can improve matching. ZIP code must be valid for the address country when provided. |
| EIN | Optional | The value can improve matching and must pass validation when provided. |
| Business phone | Optional | This field can improve matching. The primary owner's phone can be used when the business phone is unavailable. |
| Primary owner's first and last names | Optional | These fields can improve officer or agent matching. |
| ID Confirm Business result | Conditional | A successful prerequisite match is required. Lendflow runs ID Confirm Business first when no usable result is stored. |

### Report

| Application field | Requirement | Notes |
| - | - | - |
| Business search result | Conditional | A report requires a usable stored Search result. If one is unavailable, Lendflow runs Search first. |

## API flow

1. Call [Enrich Business Credit Application](/api-reference/workflow-management/enrich-business-credit-application) with the application ID in the URL.
2. Set `provider` to `clear_risk_inform_business_search`. Optionally include an underwriting `stage_id` UUID.
3. Do not include `options`; this service has no provider-specific request options.
4. Confirm `data.onqueue: true`, which means the job was queued rather than completed.
5. Poll [Get Commercial Data](/api-reference/workflow-management/get-commercial-data) with `services[]=clear_risk_inform_business_search`.
6. To reproduce the optional dashboard report action, queue `clear_risk_inform_business_report`. Lendflow runs Search first when no stored `GroupId` exists, then generates the report asynchronously.

```json theme={"system"}
{
  "provider": "clear_risk_inform_business_search",
  "stage_id": "00000000-0000-4000-8000-000000000000"
}
```

| Operation | Method and route | Result |
| - | - | - |
| Queue the service | `PUT /api/applications/{application_id}/enrich` | Returns queue acceptance. |
| Retrieve status and data | `GET /api/applications/{application_id}/commercial_data?services[]=clear_risk_inform_business_search` | Returns lifecycle status, stored request, and provider response. |

## Data Orchestration availability

The business **Clear UCC Filings** block is available in Workflow Builder. Data Orchestration exposes **UCC Filings Flag** and **UCC Filings Risk Flag Score** from Risk Inform Business Search. Their paths are based on `BusinessFlags.UCCFilings.CompanyIsDebtor`.

A stored result can satisfy the service prerequisite. If the required CLEAR entity identifier is missing, Lendflow runs the matching ID Confirm service before Risk Inform. The Risk Inform definition name and included sections are account configuration, so a block can finish successfully without the specific result area being present.

## What the service returns

| Result area | Response path | Meaning |
| - | - | - |
| Lifecycle | `data.statuses.clear.clear_risk_inform_business_search` | Latest Lendflow execution state or error message. |
| Provider status | `data.commercial_data.clear.clear_risk_inform_business_search.Status` | CLEAR's request-level status. |
| Risk Inform entity | `data.commercial_data.clear.clear_risk_inform_business_search.RiskInformBusinessSearchResult` | Matched entity, section summaries, section details, and total configured score. |
| Relevant search result | `data.commercial_data.clear.clear_risk_inform_business_search.RiskInformBusinessSearchResult.BusinessEntity.Sections.Section[].SectionDetails.BusinessFlags.UCCFilings.CompanyIsDebtor` | The UCC debtor flag returned for the matched business. |
| Optional report | `data.commercial_data.clear.clear_risk_inform_business_report.SectionResults` | Detailed report sections; the dashboard reads the UCC debtor flag from its configured custom risk details when present. |
| Submitted request | `data.request_data.clear.clear_risk_inform_business_search` | Stored provider request, including configured definition and permissible-purpose fields. Restrict access and logging. |

## Representative response

This sanitized response is abbreviated and contains no subject identifiers.

```json theme={"system"}
{
  "Status": {"StatusCode": "200", "SubStatusCode": "200"},
  "RiskInformBusinessSearchResult": {"BusinessEntity": {
    "Sections": {"Section": [{"SectionName": "Custom", "SectionDetails": {"BusinessFlags": {"UCCFilings": {
      "CompanyIsDebtor": {"RiskFlagName": "Company is Debtor in UCC Filings", "RiskFlagScore": "10.00", "RiskFlagHitIndicator": "Yes", "DocumentIdentifierInfo": {"SourceName": "UCC Filings", "DocumentGuid": "sanitized-document-id"}}
    }}}}]}, "TotalScore": "18.00"
  }}
}
```

## Response field meanings

| Field | Type | Meaning | Possible values or units | When returned |
| - | - | - | - | - |
| `Status.StatusCode` | String | Primary CLEAR status. | Provider-defined numeric string; successful fixtures use `"200"`. | When CLEAR returns a status body. |
| `RiskInformBusinessSearchResult.BusinessEntity` | Object | Matched business and configured risk assessment. | One entity object in current typed frontend handling. | When CLEAR returns a match. |
| `Header.*.@attributes.sectioncount` | String | Count for a configured section. | Integer encoded as a string. | For returned section summaries. |
| `Header.*.@attributes.sectionscore` | String | Configured points accumulated by a section. | Signed decimal string; not a probability. | For scored section summaries. |
| `Sections.Section` | Array | Definition-dependent result sections. | Zero or more section objects. | When section content exists. |
| `SectionName` | String | CLEAR section label. | For example, `"Custom"`. | For each returned section. |
| `SectionScore` | String | Configured points for the section. | Signed decimal string. | For scored sections. |
| `RiskFlagName` | String | Human-readable provider flag. | Definition-dependent text. | For a returned flag. |
| `RiskFlagHitIndicator` | String | Whether the configured condition hit. | Commonly `"Yes"` or `"No"`. | When supplied by CLEAR. |
| `RiskFlagScore` | String | Points assigned to the flag. | Signed decimal string. | For a scored flag. |
| `RiskFlagDetails` | Object or array | Flag-specific detail such as a count or amount. | Definition-dependent. | Only when CLEAR supplies detail. |
| `DocumentIdentifierInfo` | Object or array | Source label and opaque supporting-document identifier. | `SourceName` and `DocumentGuid`. | When source records support the flag. |
| `TotalScore` | String | Total points for the configured definition. | Signed decimal string; not a percentage. | For a scored entity. |

### Missing values and variable shapes

| Shape | Interpretation |
| - | - |
| Missing key or `null` | CLEAR did not return the section, the definition did not include it, or no completed result is stored. |
| Empty array | An XML element was empty. Do not interpret it as `false` or zero risk. |
| Object or array | XML conversion can produce one object for one record and an array for repeated records. Support both shapes. |
| Numeric-looking string | Preserve scores, amounts, counts, and identifiers as strings unless your own validated parser converts them. |

## Errors and statuses

| Signal | Meaning | Action |
| - | - | - |
| `Not yet started` | No run is recorded. | Queue the service or execute the published workflow. |
| `Started` | Lendflow is processing or polling CLEAR. CLEAR can return provider status `204` while results are not ready. | Continue polling. |
| `Success` | Lendflow stored a response. It does not mean a flag hit or that a record belongs to the subject. | Inspect the provider status and result object. |
| `Authorization failed.` | CLEAR rejected the configured credentials. | Correct the organization's CLEAR configuration or contact Lendflow. |
| Validation message | Required application data or a formatted value is invalid. | Correct the application and rerun. |
| Empty result or missing section | CLEAR returned no usable match or the configured definition omitted that section. | Treat the value as unavailable, not as a negative finding. |
| Provider or service error | CLEAR or Lendflow could not complete the operation. | Follow the stored message; retry only when appropriate. |

See [Data Provider Status Messages](/api-docs/docs/error-handling-external-data-provider-status-messages) for shared status guidance.

## FAQ

<AccordionGroup>
  <Accordion title="Which provider ID should I send?">
    Send `clear_risk_inform_business_search`. The Workflow Builder block ID `clear_business_uccs` is not an enrichment provider ID.
  </Accordion>

  <Accordion title="Does the block return only business UCC debtor flag?">
    No. Search returns the complete configured Risk Inform response. The dashboard selects the nested UCC result and can separately request the detailed Risk Inform Business Report.
  </Accordion>

  <Accordion title="Do I send CLEAR credentials or permissible-purpose values?">
    No. Lendflow resolves them from service configuration. Send only your Lendflow bearer token.
  </Accordion>

  <Accordion title="Does Success mean a record was found?">
    No. `Success` means Lendflow stored the response. Confirm the expected result and its `RiskFlagHitIndicator`.
  </Accordion>

  <Accordion title="Why is the relevant section missing?">
    CLEAR sections and flags depend on the account's Risk Inform definition and available public records. Missing data is unavailable, not a negative finding.
  </Accordion>
</AccordionGroup>
