> ## 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 KYC

## Clear KYC

Clear KYC uses Thomson Reuters CLEAR to search for an individual, evaluate person-level risk indicators, and retrieve a detailed Risk Inform report. Use it to support identity and risk review for a business owner or other individual associated with a deal.

The **Clear KYC** block is available for individual entities in the **KYC** category of Workflow Builder and Data Orchestration.

## Available services

The Clear KYC block contains three related services.

| Service | Required data | What it does | Dependency |
| - | - | - | - |
| **Clear Person Search** | First and last name | Searches CLEAR for a person using available identity information. | None. |
| **Clear Risk Inform Person Search** | First name, last name, city, and state for a US address | Returns risk scores and indicators for the matched person. | Requires a CLEAR person entity ID. Lendflow runs ID Confirm Person Search automatically when the ID is unavailable. |
| **Clear Risk Inform Person Report** | Group ID from a completed Risk Inform Person Search | Retrieves the detailed Risk Inform result and report PDF. | Requires a completed Risk Inform Person Search. |

The effective Risk Inform sequence is:

1. CLEAR ID Confirm Person Search identifies the person.
2. CLEAR Risk Inform Person Search evaluates the matched person.
3. CLEAR Risk Inform Person Report retrieves the detailed report when configured.

See [Clear Individual Match](/api-docs/docs/clear-individual-match) for the standalone ID Confirm and match-score service.

## Requirements

Clear uses the primary business owner's personal information and address stored on the deal. Requirements differ by service.

### Clear Person Search

| Application field | Requirement | Notes |
| - | - | - |
| First name | Required | Uses the primary owner's first name. |
| Last name | Required | Uses the primary owner's last name. |
| City | Optional | Uses the primary owner's city when available. |
| State | Optional | Must be a valid state when present. |
| Street address | Optional | More complete identity information can improve matching. |
| ZIP code | Optional | Must be valid for the primary owner's address country when present. |
| Date of birth | Optional | Used to strengthen the person match. |
| SSN or ITIN | Optional | Used to strengthen the person match. |
| Telephone | Optional | Used to strengthen the person match. |
| Country | Optional | Determines address validation and whether a state or province is applicable. |

Email is not used by these Clear KYC requests.

### Clear Risk Inform Person Search

| Application field | Requirement | Notes |
| - | - | - |
| First name | Required | Uses the primary owner's first name. |
| Last name | Required | Uses the primary owner's last name. |
| City | Required | Required by the ID Confirm step used to identify the person. |
| State | Conditional | Required for a US address and must be a valid state. |
| Street address | Optional | More complete identity information can improve matching. |
| ZIP code | Optional | Must be valid for the primary owner's address country when present. |
| Date of birth | Optional | Used to strengthen the person match. |
| SSN or ITIN | Optional | Used to strengthen the person match. |
| Telephone | Optional | Used to strengthen the person match. |
| Country | Optional | Determines address validation and whether a state or province is applicable. |
| CLEAR person entity ID | Conditional | Required to run Risk Inform Person Search. When it is unavailable, Lendflow automatically runs ID Confirm Person Search using the application fields above. |

### Clear Risk Inform Person Report

| Application field | Requirement | Notes |
| - | - | - |
| Completed Risk Inform Person Search result | Required | The report uses the group ID from a completed Risk Inform Person Search. |

## Configure Clear KYC in Data Orchestration

1. In the Lendflow Dashboard, open **Builders > Data Orchestration**.
2. Create or edit a template.
3. Add **Clear KYC** from the **KYC** service category.
4. Select the Clear services the template should run.
5. Select the result attributes that conditions should evaluate.
6. Connect the block's outcomes to the next blocks in the template.
7. Save and publish the template.

When the template needs a Risk Inform Report, configure Risk Inform Person Search before Risk Inform Person Report. Lendflow can obtain the required CLEAR person entity ID automatically, but the deal must contain the identity fields required for ID Confirm.

See [Data Orchestration](/product-guides/dashboard/data-orchestration/data-orchestration) for the complete template-building workflow.

## Run Clear KYC through the API

Data services run through a published Data Orchestration template. Your integration needs:

* An integration token with permission to access the application and run Data Orchestration.
* The application ID.
* A published template that contains the **Clear KYC** block.
* The template ID.
* The applicable workflow `stage_id` when the template is assigned to a specific stage.

1. Call [Execute Data Orchestration](/api-reference/data-orchestration/execute-data-orchestration) for the application.
2. Include `template_id` and `application_id` in the request. Include `stage_id` when applicable.
3. Confirm that the response contains `data.executed: true`.
4. Use [List Data Orchestration Logs](/api-reference/data-orchestration/list-data-orchestration-logs) and [Get Data Orchestration Log](/api-reference/data-orchestration/get-data-orchestration-log) to monitor the asynchronous run.
5. Retrieve the application's enrichment data after the service finishes to review the provider response.

An accepted execution response means the run was scheduled. It does not mean Clear has finished processing.

## What the service returns

| Response area | Meaning |
| - | - |
| `clear.person_search` | Base CLEAR person-search response. |
| `clear.clear_id_confirm_person` | Person-match response used to obtain the CLEAR entity ID. |
| `clear.clear_risk_inform_person_search` | Risk Inform search result, including total and section scores and risk-flag hits. |
| `clear.clear_risk_inform_person_report` | Detailed Risk Inform report with `RiskInformScore` and `RiskInformSummary` sections. |
| `clear.kyc_document_retrieval` | Documents retrieved as part of the ID Confirm flow when available. |

A representative response has this shape:

```json theme={"system"}
{
  "clear": {
    "clear_risk_inform_person_search": {
      "RiskInformPersonSearchResult": {
        "PersonEntity": {
          "TotalScore": "82.00",
          "Sections": {
            "Section": [
              {
                "SectionName": "Synthetic Identity",
                "SectionScore": "10.00",
                "SectionDetails": {}
              }
            ]
          }
        }
      }
    },
    "clear_risk_inform_person_report": {
      "SectionResults": [
        {
          "SectionName": "RiskInformScore",
          "SectionStatus": "Complete",
          "SectionDetails": {}
        },
        {
          "SectionName": "RiskInformSummary",
          "SectionStatus": "Complete",
          "SectionDetails": {}
        }
      ]
    }
  }
}
```

### Response attributes

| Attribute | Type | Meaning |
| - | - | - |
| `clear` | Object | Contains available CLEAR person-search, ID Confirm, Risk Inform, and document-retrieval results. |
| `clear_risk_inform_person_search` | Object | Contains the Risk Inform Person Search response. |
| `RiskInformPersonSearchResult` | Object | Root of the Risk Inform search result. |
| `PersonEntity` | Object | Matched person and the associated score sections. |
| `PersonEntity.TotalScore` | String or number | Overall score returned for the matched person. |
| `PersonEntity.Sections.Section` | Array | Risk Inform sections returned for the person. |
| `SectionName` | String | Name of a result area, such as Synthetic Identity, Single Risk Indicators, Custom, News, or Real-Time Incarceration Records. |
| `SectionScore` | String or number | Provider score for the named section. |
| `SectionDetails` | Object | Detailed records and flags for the section. Its contents depend on `SectionName`. |
| `RiskFlagName` | String | Name of a specific risk indicator. |
| `RiskFlagHitIndicator` | String | `"Yes"` when the flag was identified and `"No"` when it was not. |
| `clear_risk_inform_person_report` | Object | Contains the detailed Risk Inform Person Report response. |
| `SectionResults` | Array | Report sections returned by CLEAR. |
| `SectionStatus` | String | Processing status for the report section. |
| `RiskInformScore` | Report section | Contains the detailed score record and component sections. |
| `RiskInformSummary` | Report section | Contains the report's summarized scores and flags. |

A score is a provider result, not a pass or fail by itself. Apply your organization's review criteria. A completed request can also return no usable match, so review the provider data and service status together.

## FAQ

<AccordionGroup>
  <Accordion title="Why did Clear Risk Inform Person Search not run?">
    Confirm that the primary owner has a first name, last name, city, and a valid state for a US address. Lendflow uses that information to run ID Confirm Person Search and obtain the CLEAR entity ID required by Risk Inform.
  </Accordion>

  <Accordion title="Why is the Risk Inform Person Report unavailable?">
    The report requires a completed Risk Inform Person Search and its group ID. Run the search before the report.
  </Accordion>

  <Accordion title="What does RiskFlagHitIndicator mean?">
    `"Yes"` means CLEAR identified the named risk flag, while `"No"` means it did not. A flag does not independently determine whether the application should pass or fail.
  </Accordion>

  <Accordion title="Does an accepted API response mean Clear has finished?">
    No. `data.executed: true` means Data Orchestration was scheduled. Monitor the orchestration log to determine when the service and template finish.
  </Accordion>

  <Accordion title="Why is an older Clear result still visible?">
    The Dashboard can preserve the most recent successful response when a later request fails. Review the service status and timestamp to identify the latest attempt.
  </Accordion>
</AccordionGroup>
