Skip to content

Commit a73650b

Browse files
tdsc25tdsc25
authored
Add docs for ID-Bolt 2.2.0 API (#318)
1 parent caa3c20 commit a73650b

8 files changed

Lines changed: 172 additions & 0 deletions

File tree

‎docs/hosted/id-bolt/api-overview.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ The following options can be configured when creating an ID Bolt session:
7878
| `documentSelection` | `DocumentSelection` | Yes | Defines acceptable documents | [Document Selection](../document-selection) |
7979
| `returnDataMode` | `ReturnDataMode` | Yes | Controls what data is returned | [Data Handling](../data-handling) |
8080
| `anonymizationMode` | `AnonymizationMode` | No | Controls data anonymization | [Data Handling](../data-handling) |
81+
| `anonymizedFields` | `AnonymizedFields` | No | Fine-grained control over which fields to anonymize | [Data Handling](../data-handling) |
8182
| `scanner` | `Scanner` | No | Customizes scanner behavior | [Workflow Options](../workflow) |
8283
| `validation` | `Validators[]` | No | Validators to verify ID | [Validators](../validators) |
8384
| `locale` | `string` | No | Interface language | [Supported Locales](#supported-locales) |

‎docs/hosted/id-bolt/callbacks.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ The `CapturedId` object contains the extracted data from the scanned document. T
105105
| `mrzResult` | `MrzResult \| null` | Raw extracted data from Machine Readable Zone (MRZ) |
106106
| `vizResult` | `VizResult \| null` | Raw extracted data from Visual Inspection Zone (VIZ) |
107107
| `barcodeResult` | `BarcodeResult \| null` | Raw extracted data from barcode |
108+
| `anonymizedFields` | `IdFieldType[]` | List of fields that were anonymized for this document |
108109

109110
### DateResult Object
110111

‎docs/hosted/id-bolt/data-handling.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,79 @@ const idBoltSession = IdBoltSession.create(ID_BOLT_URL, {
6868
- **Image Anonymization**: Black boxes cover sensitive data in result images
6969

7070
When image anonymization is enabled (`ImagesOnly` or `FieldsAndImages`), and `ReturnDataMode.FullWithImages` is used, full-frame images will not be returned. Cropped images will still be available but with sensitive areas obscured.
71+
72+
## Anonymized Fields
73+
74+
In addition to the anonymization mode, you can configure exactly which fields are anonymized using the `anonymizedFields` option. This gives you fine-grained control per document type.
75+
76+
```ts
77+
const idBoltSession = IdBoltSession.create(ID_BOLT_URL, {
78+
// other options...
79+
anonymizationMode: AnonymizationMode.FieldsOnly,
80+
anonymizedFields: {
81+
defaultFields: true,
82+
extraFields: [
83+
{
84+
document: new IdCard(Region.Any),
85+
fields: [IdFieldType.DocumentNumber, IdFieldType.DateOfBirth]
86+
}
87+
]
88+
}
89+
});
90+
```
91+
92+
### Configuration
93+
94+
The `anonymizedFields` option accepts an object with two properties:
95+
96+
| Property | Type | Description |
97+
| -------- | ---- | ----------- |
98+
| `defaultFields` | `boolean` | When `true`, the default set of sensitive fields is anonymized. |
99+
| `extraFields` | `AnonymizedFieldEntry[]` | Additional fields to anonymize for specific document types, on top of the defaults. |
100+
101+
Each `AnonymizedFieldEntry` specifies a document type and the fields to anonymize for that document:
102+
103+
| Property | Type | Description |
104+
| -------- | ---- | ----------- |
105+
| `document` | `IdCaptureDocument` | The document type this entry applies to (e.g. `new Passport(Region.Any)`, `new IdCard("USA")`). |
106+
| `fields` | `IdFieldType[]` | The fields to anonymize for this document type. |
107+
108+
### Available Field Types
109+
110+
The `IdFieldType` enum defines the fields that can be anonymized:
111+
112+
| Value | Description |
113+
| ----- | ----------- |
114+
| `IdFieldType.FirstName` | First name |
115+
| `IdFieldType.LastName` | Last name |
116+
| `IdFieldType.FullName` | Full name |
117+
| `IdFieldType.Sex` | Sex/gender |
118+
| `IdFieldType.Nationality` | Nationality |
119+
| `IdFieldType.Address` | Address |
120+
| `IdFieldType.AdditionalAddressInformation` | Additional address information |
121+
| `IdFieldType.AdditionalNameInformation` | Additional name information |
122+
| `IdFieldType.Age` | Age |
123+
| `IdFieldType.DateOfBirth` | Date of birth |
124+
| `IdFieldType.DateOfExpiry` | Date of expiry |
125+
| `IdFieldType.DateOfIssue` | Date of issue |
126+
| `IdFieldType.DocumentNumber` | Document number |
127+
| `IdFieldType.DocumentAdditionalNumber` | Document additional number |
128+
| `IdFieldType.PersonalIdNumber` | Personal ID number |
129+
| `IdFieldType.IssuingAuthority` | Issuing authority |
130+
| `IdFieldType.PlaceOfBirth` | Place of birth |
131+
| `IdFieldType.Profession` | Profession |
132+
| `IdFieldType.Employer` | Employer |
133+
| `IdFieldType.MaritalStatus` | Marital status |
134+
| `IdFieldType.FathersName` | Father's name |
135+
| `IdFieldType.MothersName` | Mother's name |
136+
| `IdFieldType.Race` | Race |
137+
| `IdFieldType.Religion` | Religion |
138+
| `IdFieldType.BloodType` | Blood type |
139+
| `IdFieldType.ResidentialStatus` | Residential status |
140+
| `IdFieldType.MrzOptionalDataInLine1` | MRZ optional data in line 1 |
141+
| `IdFieldType.MrzOptionalDataInLine2` | MRZ optional data in line 2 |
142+
| `IdFieldType.BarcodeDictionary` | Barcode dictionary |
143+
144+
### Result
145+
146+
The `CapturedId` object returned in the `onCompletion` callback includes an `anonymizedFields` property — an array of `IdFieldType` values indicating which fields were actually anonymized for the scanned document.

‎docs/hosted/id-bolt/release-notes.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ hide_title: true
99
title: Release Notes
1010
---
1111

12+
## 2.2.0
13+
14+
**Released**: February 24, 2026
15+
16+
### New Features
17+
18+
* Granular anonymization control: configure which specific fields to anonymize, either using a default set or by specifying extra fields per document type. See [Data Handling](../data-handling) for details.
19+
1220
## 2.1.0
1321

1422
**Released**: January 21, 2026

‎versioned_docs/version-7.6.7/hosted/id-bolt/api-overview.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ The following options can be configured when creating an ID Bolt session:
7878
| `documentSelection` | `DocumentSelection` | Yes | Defines acceptable documents | [Document Selection](../document-selection) |
7979
| `returnDataMode` | `ReturnDataMode` | Yes | Controls what data is returned | [Data Handling](../data-handling) |
8080
| `anonymizationMode` | `AnonymizationMode` | No | Controls data anonymization | [Data Handling](../data-handling) |
81+
| `anonymizedFields` | `AnonymizedFields` | No | Fine-grained control over which fields to anonymize | [Data Handling](../data-handling) |
8182
| `scanner` | `Scanner` | No | Customizes scanner behavior | [Workflow Options](../workflow) |
8283
| `validation` | `Validators[]` | No | Validators to verify ID | [Validators](../validators) |
8384
| `locale` | `string` | No | Interface language | [Supported Locales](#supported-locales) |

‎versioned_docs/version-7.6.7/hosted/id-bolt/callbacks.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,7 @@ The `CapturedId` object contains the extracted data from the scanned document. T
105105
| `mrzResult` | `MrzResult \| null` | Raw extracted data from Machine Readable Zone (MRZ) |
106106
| `vizResult` | `VizResult \| null` | Raw extracted data from Visual Inspection Zone (VIZ) |
107107
| `barcodeResult` | `BarcodeResult \| null` | Raw extracted data from barcode |
108+
| `anonymizedFields` | `IdFieldType[]` | List of fields that were anonymized for this document |
108109

109110
### DateResult Object
110111

‎versioned_docs/version-7.6.7/hosted/id-bolt/data-handling.md‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,79 @@ const idBoltSession = IdBoltSession.create(ID_BOLT_URL, {
6868
- **Image Anonymization**: Black boxes cover sensitive data in result images
6969

7070
When image anonymization is enabled (`ImagesOnly` or `FieldsAndImages`), and `ReturnDataMode.FullWithImages` is used, full-frame images will not be returned. Cropped images will still be available but with sensitive areas obscured.
71+
72+
## Anonymized Fields
73+
74+
In addition to the anonymization mode, you can configure exactly which fields are anonymized using the `anonymizedFields` option. This gives you fine-grained control per document type.
75+
76+
```ts
77+
const idBoltSession = IdBoltSession.create(ID_BOLT_URL, {
78+
// other options...
79+
anonymizationMode: AnonymizationMode.FieldsOnly,
80+
anonymizedFields: {
81+
defaultFields: true,
82+
extraFields: [
83+
{
84+
document: new IdCard(Region.Any),
85+
fields: [IdFieldType.DocumentNumber, IdFieldType.DateOfBirth]
86+
}
87+
]
88+
}
89+
});
90+
```
91+
92+
### Configuration
93+
94+
The `anonymizedFields` option accepts an object with two properties:
95+
96+
| Property | Type | Description |
97+
| -------- | ---- | ----------- |
98+
| `defaultFields` | `boolean` | When `true`, the default set of sensitive fields is anonymized. |
99+
| `extraFields` | `AnonymizedFieldEntry[]` | Additional fields to anonymize for specific document types, on top of the defaults. |
100+
101+
Each `AnonymizedFieldEntry` specifies a document type and the fields to anonymize for that document:
102+
103+
| Property | Type | Description |
104+
| -------- | ---- | ----------- |
105+
| `document` | `IdCaptureDocument` | The document type this entry applies to (e.g. `new Passport(Region.Any)`, `new IdCard("USA")`). |
106+
| `fields` | `IdFieldType[]` | The fields to anonymize for this document type. |
107+
108+
### Available Field Types
109+
110+
The `IdFieldType` enum defines the fields that can be anonymized:
111+
112+
| Value | Description |
113+
| ----- | ----------- |
114+
| `IdFieldType.FirstName` | First name |
115+
| `IdFieldType.LastName` | Last name |
116+
| `IdFieldType.FullName` | Full name |
117+
| `IdFieldType.Sex` | Sex/gender |
118+
| `IdFieldType.Nationality` | Nationality |
119+
| `IdFieldType.Address` | Address |
120+
| `IdFieldType.AdditionalAddressInformation` | Additional address information |
121+
| `IdFieldType.AdditionalNameInformation` | Additional name information |
122+
| `IdFieldType.Age` | Age |
123+
| `IdFieldType.DateOfBirth` | Date of birth |
124+
| `IdFieldType.DateOfExpiry` | Date of expiry |
125+
| `IdFieldType.DateOfIssue` | Date of issue |
126+
| `IdFieldType.DocumentNumber` | Document number |
127+
| `IdFieldType.DocumentAdditionalNumber` | Document additional number |
128+
| `IdFieldType.PersonalIdNumber` | Personal ID number |
129+
| `IdFieldType.IssuingAuthority` | Issuing authority |
130+
| `IdFieldType.PlaceOfBirth` | Place of birth |
131+
| `IdFieldType.Profession` | Profession |
132+
| `IdFieldType.Employer` | Employer |
133+
| `IdFieldType.MaritalStatus` | Marital status |
134+
| `IdFieldType.FathersName` | Father's name |
135+
| `IdFieldType.MothersName` | Mother's name |
136+
| `IdFieldType.Race` | Race |
137+
| `IdFieldType.Religion` | Religion |
138+
| `IdFieldType.BloodType` | Blood type |
139+
| `IdFieldType.ResidentialStatus` | Residential status |
140+
| `IdFieldType.MrzOptionalDataInLine1` | MRZ optional data in line 1 |
141+
| `IdFieldType.MrzOptionalDataInLine2` | MRZ optional data in line 2 |
142+
| `IdFieldType.BarcodeDictionary` | Barcode dictionary |
143+
144+
### Result
145+
146+
The `CapturedId` object returned in the `onCompletion` callback includes an `anonymizedFields` property — an array of `IdFieldType` values indicating which fields were actually anonymized for the scanned document.

‎versioned_docs/version-7.6.7/hosted/id-bolt/release-notes.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ hide_title: true
99
title: Release Notes
1010
---
1111

12+
## 2.2.0
13+
14+
**Released**: February 24, 2026
15+
16+
### New Features
17+
18+
* Granular anonymization control: configure which specific fields to anonymize, either using a default set or by specifying extra fields per document type. See [Data Handling](../data-handling) for details.
19+
1220
## 2.1.0
1321

1422
**Released**: January 21, 2026

0 commit comments

Comments
 (0)