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

# Biometric Onboarding

Biometric verification combining facematch and liveness detection to confirm a customer's identity during initial onboarding, with an optional injection attack detection variant for stronger assurance. Also registers a customer's face with the biometric supplier and returns a stored-face reference, so later journeys can reverify that person against it.

This page documents the **Biometric Onboarding** module, including its variants, capabilities, and the result values it returns.

## Biometric Onboarding: Biometrics Onboarding with Injection Attack Detection

Biometric verification combining facematch, liveness detection, and injection attack protection, using an encrypted selfie to securely confirm a customer's identity during initial onboarding.

### Capabilities

The module returns the following capabilities.

#### Overall result

Final outcome of the onboarding process.

| Code | Label | Description |
| - | - | - |
| `Passed` | Passed | Onboarding passed |
| `Failed` | Failed | Onboarding failed |
| `Error` | Error | Onboarding error |

#### IAD: capture liveness

IAD capture liveness result.

| Code | Label | Description |
| - | - | - |
| `Live` | Live | Capture is live |
| `Not Live` | Not Live | Capture is not live |
| `Error` | Error | Liveness check error |

#### Face liveness

Face liveness result.

| Code | Label | Description |
| - | - | - |
| `Live` | Live | Face is live |
| `Not Live` | Not Live | Face is not live |
| `Error` | Error | Face liveness error |

#### Face match

Face match result.

| Code | Label | Description |
| - | - | - |
| `Match` | Match | Face matched |
| `No Match` | No Match | Face did not match |
| `Error` | Error | Face match error |

### Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

| Outcome | Condition | Description |
| - | - | - |
| `Success` | Overall Result is `Passed` | All onboarding checks passed. The selfie is live, not injected, and matches the anchor image. |
| `Failed` | Overall Result is `Failed` | One or more onboarding checks failed. This outcome typically routes to rejection or escalation, depending on your fraud policy. |
| `ERROR` | default, when no conditions matched | An unexpected error occurred, so the module couldn't determine an overall result. |

### Input payload

The following is a sample payload used to submit data to the **Biometrics Onboarding with Injection Attack Detection** module for processing.

```json JSON theme={null}
{
  "context": {
    "subject": {
      "biometrics": [
        {
          "type": "encryptedSelfie",
          "selfieImageEncryption": true,
          "selfieImage": "<base64-image>"
        },
        {
          "type": "anchorImage",
          "anchorImage": "<base64-image>"
        }
      ],
      "identity": {}
    }
  }
}
```

| Field | Required | Description |
| - | - | - |
| `EncryptedSelfie` | Yes | An encrypted selfie image of the subject, used for the liveness, injection attack detection, and face match checks. Set `selfieImageEncryption` to `true`. |
| `AnchorImage` | Yes | A trusted reference image of the subject to compare the selfie against. |

### Sample response

The following is a sample response returned by the module.

```json JSON theme={null}
{
  "response": {
    "advice": {
      "overallResult": "Failed"
    },
    "status": "complete",
    "outcome": "Failed"
  }
}
```

## Biometric Onboarding: Biometrics Onboarding

Biometric verification combining facematch and liveness detection, designed to confirm a customer's identity during initial onboarding.

### Capabilities

The module returns the following capabilities.

#### Facematch result

Indicates whether the face in the selfie matches the face in the anchor image.

| Code | Label | Description |
| - | - | - |
| `Match` | Match | Face is matched |
| `No Match` | No Match | Face is not matched |

#### Facematch score

Returns an integer similarity score (0-100) indicating how closely the selfie matches the anchor image.

| Detail | Description |
| - | - |
| Type | Integer |
| Range | 0–100 |
| Default | `0` |

#### Liveness score

Returns an integer score (0-100) indicating the confidence that the selfie was captured from a genuinely present person.

| Detail | Description |
| - | - |
| Type | Integer |
| Range | 0–100 |
| Default | `0` |

### Default outcomes

The module is pre-configured with the following default outcomes, which can be used in evaluation and routing logic within the journey designer.

| Outcome | Condition | Description |
| - | - | - |
| `Success` | Facematch Result is `Match` and Liveness Score >= `75` | The selfie matches the anchor image, and the liveness score shows high confidence that a real, live person is present. |
| `Review` | Facematch Result is `Match` and Liveness Score >= `60` and Liveness Score \< `75` | The selfie matches the anchor image, but the liveness score shows only moderate confidence. This outcome typically routes to manual review. |
| `Fail` | Facematch Result is `No Match` or Liveness Score \< `60` | The selfie doesn't match the anchor image, or the liveness score shows low confidence that a real, live person is present. This outcome typically routes to rejection or escalation. |
| `ERROR` | default, when no conditions matched | An unexpected error occurred, so the module returned no decision. |

### Input payload

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

```json JSON theme={null}
{
  "context": {
    "subject": {
      "biometrics": [
        {
          "type": "selfie",
          "selfieImageEncryption": false,
          "selfieImage": "<base64-image>"
        },
        {
          "type": "anchorImage",
          "anchorImage": "<base64-image>"
        }
      ],
      "identity": {}
    }
  }
}
```

| Field | Required | Description |
| - | - | - |
| `Selfie` | Yes | A selfie image of the subject, used for the facematch and liveness checks. |
| `AnchorImage` | Yes | A trusted reference image of the subject to compare the selfie against. |

### Sample response

The following is a sample response returned by the module.

```json JSON theme={null}
{
  "response": {
    "advice": {
      "facematchResult": "No Match",
      "facematchScore": 22,
      "livenessScore": 45
    },
    "outcome": "Fail"
  }
}
```