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

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 returns capabilities grouped into CCJ checks, insolvency and debt checks, and lookup status.

### 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 were found. `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 (in GBP) of unsatisfied CCJs. |
| Recency of unsatisfied CCJs found | `0-12`, `13-36`, `37-72`, `N/A` | How recently (in months) the most recent unsatisfied CCJ was registered. |

### 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 recently (in months) an insolvency event was recorded. |
| Months since Debt Recovery Order | `0-12`, `13-36`, `37-72`, `No DRO found` | How recently (in months) a DRO was recorded. |
| Number of Debt Arrangement Schemes (not discharged) | `1 or more`, `No Debt Arrangement Scheme (not discharged) found` | Whether there is at least one active (not discharged) Debt Arrangement Scheme. |

### Lookup status

Whether the subject and address were found in the records.

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

## Default outcomes

High Risk evaluates first with an `or` combinator — 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 | A single unsatisfied CCJ was found, with no insolvency, DRO, or active debt arrangement scheme. |
| `Low Risk` | Number of Unsatisfied CCJs Found is `0` or No Information Found is `true` | No unsatisfied CCJs on record, or the subject was not found in financial records (no adverse data). |
| `Error` | Default (no conditions matched) | An unexpected error occurred. |

## Input payload

The following is a sample payload used to submit data to the **UK Financial Vulnerability** module for processing.

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

| Field | Required | Description |
| - | - | - |
| `FullName` | Yes | The subject's full name, including given and family names. |
| `CurrentAddress/building` | Yes | The building name or number of the current address. |
| `CurrentAddress/thoroughfare` | No | The street or thoroughfare of the current address. |
| `CurrentAddress/locality` | Yes | The locality (town or city) of the current address. |
| `CurrentAddress/postalCode` | Yes | The postal or ZIP code of the current address. |
| `CurrentAddress/country` | No | The country of the current address. |
| `CurrentAddress/administrativeArea` | No | The administrative area (for example, state, province, or county) of the current address. |
| `DateOfBirth` | No | The subject's date of birth. |

## 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": {
      "addressFound": true,
      "debtArrangementScheme": "No Debt Arrangement Scheme (not discharged) found",
      "monthsSinceDebtRecoveryOrder": "No DRO found",
      "monthsSinceInsolvency": "0-12",
      "noInformationFound": false,
      "numberOfUnsatisfiedCcjsFound": ">1",
      "recencyOfUnsatisfiedCcjsFound": "0-12",
      "valueOfUnsatisfiedCcjsFound": "1-500"
    },
    "outcome": "High Risk"
  }
}
```

## Related guides and tutorials

The following guides and tutorials use this module or explain how to configure it.

> **[Run the age verification API sample app](/docs/go-v2/tutorials/gaming-age-verification.md)**
>
> Confirm a player meets the age requirement.