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

# Financial Vulnerability

> Check UK public records for indicators of financial distress.

export const VersionWarningBanner = () => {
  const [latestUrl, setLatestUrl] = useState(null);
  useEffect(() => {
    if (typeof window === "undefined") return;
    const {pathname, hash, search} = window.location;
    if (!pathname.includes("/go-v1/")) return;
    setLatestUrl(`${pathname.replace("/go-v1/", "/go-v2/")}${search}${hash}`);
  }, []);
  if (!latestUrl) return null;
  return <div className="not-prose my-6 rounded-xl border border-amber-500/30 bg-amber-500/10 px-4 py-3 text-sm text-gray-800 dark:text-gray-100">
      ⚠️ You are viewing the <strong>GBG GO v1</strong> documentation.
      <a href={latestUrl} className="ml-2 font-medium underline text-amber-700 dark:text-amber-400 hover:text-amber-800 dark:hover:text-amber-300">
        View the latest version (v2) →
      </a>
    </div>;
};

<VersionWarningBanner />

The **Financial Vulnerability** module checks UK public records for indicators of financial distress, including County Court Judgments (CCJs), insolvency records, Debt Recovery Orders (DROs), and Debt Arrangement Schemes. It's designed for affordability and responsible lending assessments.

## UK financial vulnerability

This variant checks a UK subject against public financial records from the last 6 years. It returns the count, value, and recency of unsatisfied CCJs, plus flags for insolvency, DROs, and active debt arrangement schemes.

**Required inputs:** full name, building, locality, postal code.

**Optional inputs:** thoroughfare, country, administrative area, date of birth.

## Capabilities

The module groups capabilities into three categories. CCJ checks cover County Court Judgments. Insolvency and debt checks cover insolvency events, Debt Recovery Orders, and Debt Arrangement Schemes. Lookup status covers whether the records include the subject and address.

### CCJ capabilities

County Court Judgments from the last 6 years.

| Capability                        | Values                                                             | Description                                                               |
| --------------------------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| Number of unsatisfied CCJs found  | `0`, `1`, `>1`, `N/A`                                              | How many unsatisfied CCJs the records show. `N/A` = no CCJ records found. |
| Value of unsatisfied CCJs found   | `0`, `1-500`, `501-1000`, `1001-1500`, `1501-3000`, `>3000`, `N/A` | The total value of unsatisfied CCJs.                                      |
| Recency of unsatisfied CCJs found | `0-12`, `13-36`, `37-72`, `N/A`                                    | How many months since the most recent unsatisfied CCJ in the records.     |

### Insolvency and debt capabilities

Insolvency events, Debt Recovery Orders, and Debt Arrangement Schemes.

| Capability                                          | Values                                                           | Description                                                   |
| --------------------------------------------------- | ---------------------------------------------------------------- | ------------------------------------------------------------- |
| Months since insolvency                             | `0-12`, `13-36`, `37-72`, `No Insolvency found`                  | How many months since an insolvency event in the records.     |
| Months since Debt Recovery Order                    | `0-12`, `13-36`, `37-72`, `No DRO found`                         | How many months since a DRO in the records.                   |
| Number of Debt Arrangement Schemes (not discharged) | `1 or more`, `No Debt Arrangement Scheme (not discharged) found` | Whether there is at least one active Debt Arrangement Scheme. |

### Lookup status

Whether the records include the subject and address.

| Capability           | Type    | Values              | Description                                                    |
| -------------------- | ------- | ------------------- | -------------------------------------------------------------- |
| No information found | Boolean | `isTrue`, `isFalse` | Whether the records include the subject. Defaults to `isTrue`. |
| Address found        | Boolean | `isTrue`, `isFalse` | Whether the records include the address.                       |

## Default outcomes

High Risk evaluates first with an `or` combinator, so any single high-risk indicator triggers it.

| Outcome       | Condition                                                                                                                                                           | Description                                                                                            |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `High Risk`   | More than 1 unsatisfied CCJ or any insolvency record (regardless of recency) or any DRO record (regardless of recency) or 1 or more active Debt Arrangement Schemes | One or more serious financial distress indicators found.                                               |
| `Medium Risk` | Exactly 1 unsatisfied CCJ                                                                                                                                           | The records show a single unsatisfied CCJ, with no insolvency, DRO, or active debt arrangement scheme. |
| `Low Risk`    | 0 unsatisfied CCJs or no information found is `isTrue`                                                                                                              | No unsatisfied CCJs on record, or the subject wasn't found in financial records.                       |
| `Error`       | Default (no conditions matched)                                                                                                                                     | An unexpected error occurred.                                                                          |

## Input payload

The following is a sample payload used to submit subject details to the **UK Financial Vulnerability** variant for processing.

```json JSON theme={null}
{
  "resourceId": "<resourceId>",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "postalCode": "CB6 1AN",
          "locality": "ELY",
          "thoroughfare": "WEST FEN ROAD",
          "building": "3990",
          "administrativeArea": ""
        },
        "dateOfBirth": "1977-06-16",
        "firstName": "JOHN",
        "lastNames": ["DOE"],
        "middleNames": ["V"]
      }
    }
  }
}
```

| Field                                        | Required | Description                                                                                 |
| -------------------------------------------- | -------- | ------------------------------------------------------------------------------------------- |
| `identity.firstName`                         | Yes      | First name of the subject.                                                                  |
| `identity.lastNames`                         | Yes      | Array containing the last names of the subject.                                             |
| `identity.currentAddress.building`           | Yes      | Building name or number of the subject's current address.                                   |
| `identity.currentAddress.locality`           | Yes      | Town or city.                                                                               |
| `identity.currentAddress.postalCode`         | Yes      | Postal code.                                                                                |
| `identity.middleNames`                       | No       | Array containing the middle names of the subject.                                           |
| `identity.dateOfBirth`                       | No       | Date of birth in `YYYY-MM-DD` format.                                                       |
| `identity.currentAddress.thoroughfare`       | No       | Street name of the subject's current address.                                               |
| `identity.currentAddress.administrativeArea` | No       | County or administrative area.                                                              |
| `identity.currentAddress.country`            | No       | Country code in International Organization for Standardization (ISO) 3166-1 alpha-3 format. |

## Sample response

The following is a sample response where multiple unsatisfied CCJs and a recent insolvency returned a `High Risk` outcome.

```json JSON theme={null}
{
  "response": {
    "advice": {
      "contains": {
        "numberOfUnsatisfiedCcjsFound": ">1",
        "valueOfUnsatisfiedCcjsFound": "1-500",
        "recencyOfUnsatisfiedCcjsFound": "0-12",
        "monthsSinceInsolvency": "0-12",
        "debtArrangementScheme": "No Debt Arrangement Scheme (not discharged) found",
        "addressFound": true,
        "monthsSinceDebtRecoveryOrder": "No DRO found",
        "noInformationFound": false
      }
    },
    "outcome": "High Risk"
  }
}
```
