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

# Data Information Capture

> Collect a subject's name, address, date of birth, email, or GOV.UK share code in a GBG Go journey without running a verification check.

Captures name, address, date of birth, email, or GOV.UK share code from the end user with no verification and no vendor call.

This page documents the **Data Information Capture** module, including its variants, capabilities, and the result values it returns.

## Data Information Capture: Optional Capture

Captures the subject's name, current address, previous addresses, date of birth, and personal email from the end user. It doesn't verify the data or call a data source.

Every element is optional, so the variant needs no configuration and never blocks a journey on missing data. Use it before document classification or document and biometric steps when later steps or the Investigation Portal need the captured values.

### Capabilities

The module returns the following capabilities.

#### Capture attempted

True once the capture step has run, and false only on timeout. It doesn't show what the end user supplied, so read `context.subject` for that.

| Detail | Description |
| - | - |
| Type | Boolean |
| Default | `isFalse` |

### Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

| Outcome | Condition | Description |
| - | - | - |
| `Data Captured` | Capture Attempted is `true` | The capture step ran. The end user might not have supplied any data. |
| `Error` | An error occurs during processing | A system error stopped the capture step from completing. |
| `No Data Captured` | Default, when no conditions matched | The capture step didn't complete, for example, because it timed out. |

### Input payload

The following is a sample payload used to submit data to the **Optional Capture** module for processing.

```json JSON theme={null}
{
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "currentAddress": {
          "administrativeArea": "Cheshire",
          "country": "GBR",
          "locality": "Sampletown",
          "postalCode": "AB1 2CD",
          "premise": "1",
          "thoroughfare": "Sample Street"
        },
        "dateOfBirth": "1912-01-01",
        "emails": [
          {
            "email": "alan.turing@example.com",
            "type": "personal"
          }
        ],
        "firstName": "Jane",
        "lastNames": [
          "Doe"
        ],
        "middleNames": [
          "Marie"
        ],
        "previousAddresses": [
          {
            "country": "GBR",
            "locality": "Sampletown",
            "postalCode": "AB1 2CD",
            "premise": "1",
            "thoroughfare": "Sample Street"
          }
        ],
        "title": "Mr"
      }
    }
  }
}
```

| Field | Required | Description |
| - | - | - |
| `FullName` | No | The subject's full name, including given and family names. |
| `CurrentAddress` | No | The subject's current residential address. |
| `PreviousAddresses` | No | The subject's previous residential addresses. |
| `DateOfBirth` | No | The subject's date of birth. |
| `PersonalEmail` | No | The subject's personal email address. |

### Sample response

The following is a sample response returned by the module.

```json JSON theme={null}
{
  "response": {
    "advice": {
      "captureAttempted": true
    },
    "outcome": "Data Captured"
  }
}
```

## Data Information Capture: Share Code Capture

Captures the applicant's date of birth and GOV.UK share code from the end user. Applicants use the share code to prove their Right to Work or Right to Rent. The variant doesn't verify the data, call a data source, or contact GOV.UK.

Both elements are optional, so the variant needs no configuration and never blocks a journey on missing data. A reviewer checks the code on GOV.UK from the journey session in the Investigation Portal.

### Capabilities

The module returns the following capabilities.

#### Capture attempted

True once the capture step has run, and false only on timeout. It doesn't show what the end user supplied, so read `context.subject` for that.

| Detail | Description |
| - | - |
| Type | Boolean |
| Default | `isFalse` |

### Default outcomes

The following default outcomes are available for evaluation and routing in the Journey builder.

| Outcome | Condition | Description |
| - | - | - |
| `Data Captured` | Capture Attempted is `true` | The capture step ran. The end user might not have supplied any data. |
| `Error` | An error occurs during processing | A system error stopped the capture step from completing. |
| `No Data Captured` | Default, when no conditions matched | The capture step didn't complete, for example, because it timed out. |

### Input payload

The following is a sample payload used to submit data to the **Share Code Capture** module for processing.

```json JSON theme={null}
{
  "context": {
    "config": {
      "delivery": "api"
    },
    "subject": {
      "identity": {
        "dateOfBirth": "1912-06-23",
        "idNumbers": [
          {
            "idNumber": "A12B34C5D",
            "type": "gbShareCode"
          }
        ]
      }
    }
  }
}
```

| Field | Required | Description |
| - | - | - |
| `GBShareCode` | No | The subject's GOV.UK share code for a Right to Work or Right to Rent check. |
| `DateOfBirth` | No | The subject's date of birth. |

### Sample response

The following is a sample response returned by the module.

```json JSON theme={null}
{
  "response": {
    "advice": {
      "captureAttempted": true
    },
    "outcome": "Data Captured"
  }
}
```
